UNPKG

@selfcommunity/react-ui

Version:

React UI Components to integrate a Community created with SelfCommunity Platform.

52 lines (43 loc) 1.15 kB
import { SCUserType } from '@selfcommunity/types'; export interface FollowUserButtonProps { /** * Overrides or extends the styles applied to the component. * @default null */ className?: string; /** * Id of the user * @default null */ userId?: number; /** * User * @default null */ user?: SCUserType; /** * onFollow callback * @param user * @param followed */ onFollow?: (user: SCUserType, followed: boolean) => any; /** * Others properties */ [p: string]: any; } /** * > API documentation for the Community-JS Follow User Button component. Learn about the available props and the CSS API. #### Import ```jsx import {FollowUserButton} from '@selfcommunity/react-ui'; ``` #### Component Name The name `SCFollowUserButton` can be used when providing style overrides in the theme. #### CSS |Rule Name|Global class|Description| |---|---|---| |root|.SCFollowUserButton-root|Styles applied to the root element.| * @param inProps */ export default function FollowUserButton(inProps: FollowUserButtonProps): JSX.Element;