@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
56 lines (51 loc) • 1.72 kB
TypeScript
import { BoxProps } from '@mui/material';
import { SCLiveStreamType } from '@selfcommunity/types';
export interface LiveStreamFormProps extends BoxProps {
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Event Object
* @default null
*/
liveStream?: SCLiveStreamType;
/**
* On success callback function
* @default null
*/
onSuccess?: (data: SCLiveStreamType) => void;
/**
* On error callback function
* @default null
*/
onError?: (error: any) => void;
/**
* Any other properties
*/
[p: string]: any;
}
/**
*> API documentation for the Community-JS LiveStreamForm component. Learn about the available props and the CSS API.
*
#### Import
```jsx
import {LiveStreamForm} from '@selfcommunity/react-ui';
```
#### Component Name
The name `LiveStreamForm` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCLiveStreamForm-root|Styles applied to the root element.|
|title|.SCLiveStreamForm-title|Styles applied to the title element.|
|cover|.SCLiveStreamForm-cover|Styles applied to the cover field.|
|form|.SCLiveStreamForm-form|Styles applied to the form element.|
|name|.SCLiveStreamForm-name|Styles applied to the name field.|
|description|.SCLiveStreamForm-description|Styles applied to the description field.|
|content|.SCLiveStreamForm-content|Styles applied to the element.|
|error|.SCLiveStreamForm-error|Styles applied to the error elements.|
* @param inProps
*/
export default function LiveStreamForm(inProps: LiveStreamFormProps): JSX.Element;