@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
53 lines (44 loc) • 1.26 kB
TypeScript
import { SCUserType } from '@selfcommunity/types';
import { SCUserProfileFields } from '../../types';
export interface UserInfoProps {
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Id of user object
* @default null
*/
userId?: number;
/**
* User Object
* @default null
*/
user?: SCUserType;
/**
* User fields to display in the profile
* @default [real_name, date_joined, date_of_birth, website, description, bio]
*/
fields?: SCUserProfileFields[];
/**
* Any other properties
*/
[p: string]: any;
}
/**
* > API documentation for the Community-JS User Info component. Learn about the available props and the CSS API.
#### Import
```jsx
import {UserInfo} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCUserInfo` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCUserInfo-root|Styles applied to the root element.|
|field|.SCUserInfo-field|Styles applied to the field element.|
* @param inProps
*/
export default function UserInfo(inProps: UserInfoProps): JSX.Element;