@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
55 lines (46 loc) • 1.73 kB
TypeScript
import React from 'react';
import { SCPrivateMessageSnippetType } from '@selfcommunity/types';
export interface PrivateMessageSnippetItemProps {
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* PrivateMessageItem Object
* @default null
*/
message?: SCPrivateMessageSnippetType;
/**
* Callback fired on item click
*/
onItemClick?: () => void;
/**
* Item secondary action (visible only on mobile view)
*/
secondaryAction?: React.ReactNode;
/**
* Any other properties
*/
[p: string]: any;
}
/**
* > API documentation for the Community-JS PrivateMessageSnippetItem component. Learn about the available props and the CSS API.
#### Import
```jsx
import {PrivateMessageSnippetItem} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCPrivateMessageSnippetItem` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCPrivateMessageSnippetItem-root|Styles applied to the root element.|
|username|.SCPrivateMessageSnippetItem-username|Styles applied to the username element.|
|badgeLabel|.SCPrivateMessageSnippetItem-badgeLabel|Styles applied to the badgeLabel element.|
|time|.SCPrivateMessageSnippetItem-time|Styles applied to the time element.|
|menuItem|.SCPrivateMessageSnippetItem-menu-item|Styles applied to the menu item element.|
|unread|.SCPrivateMessageSnippetItem-unread|Styles applied to snippet item if there's an unread message.|
* @param inProps
*/
export default function PrivateMessageSnippetItem(inProps: PrivateMessageSnippetItemProps): JSX.Element;