@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
52 lines (43 loc) • 1.22 kB
TypeScript
import { SCCategoryType } from '@selfcommunity/types';
export interface CategoryFollowButtonProps {
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Id of the category
* @default null
*/
categoryId?: number;
/**
* Category Object
* @default null
*/
category?: SCCategoryType;
/**
* onFollow callback
* @param user
* @param followed
*/
onFollow?: (category: SCCategoryType, followed: boolean) => any;
/**
* Others properties
*/
[p: string]: any;
}
/**
* > API documentation for the Community-JS Follow Category Button component. Learn about the available props and the CSS API.
#### Import
```jsx
import {CategoryFollowButton} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCCategoryFollowButton` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCCategoryFollowButton-root|Styles applied to the root element.|
* @param inProps
*/
export default function CategoryFollowButton(inProps: CategoryFollowButtonProps): JSX.Element;