mediasfu-reactnative
Version:
MediaSFU Prebuilt React Native SDK
39 lines (38 loc) • 1.17 kB
TypeScript
import React from 'react';
export interface AudioGridOptions {
componentsToRender: React.ReactNode[];
}
export type AudioGridType = (options: AudioGridOptions) => React.ReactNode;
/**
* AudioGrid component renders a grid layout of audio components or elements.
*
* This component organizes an array of audio components or elements into a flexible grid.
*
* @component
* @param {AudioGridOptions} props - Properties for the AudioGrid component.
* @param {React.ReactNode[]} props.componentsToRender - Array of React components or elements to render in the grid.
*
* @returns {JSX.Element} The AudioGrid component rendering a grid of audio components.
*
* @example
* ```tsx
* import React from 'react';
* import { AudioGrid, AudioCard } from 'mediasfu-reactnative';
*
* function App() {
* const components = [
* <AudioCard name="Participant 1" />,
* <AudioCard name="Participant 2" />,
* <AudioCard name="Participant 3" />
* ];
*
* return (
* <AudioGrid componentsToRender={components} />
* );
* }
*
* export default App;
* ```
*/
declare const AudioGrid: React.FC<AudioGridOptions>;
export default AudioGrid;