rtk-grid
{/* AUTO-GENERATED FILE. DO NOT EDIT MANUALLY. Any manual changes will be overwritten the next time the docs are generated.
Source: https://github.com/cloudflare/realtimekit-ui/blob/main/packages/core/src/components/rtk-grid/rtk-grid.tsx Generator: https://github.com/cloudflare/realtimekit-ui/blob/main/scripts/generate-stencil-docs.js
To update this page, edit the component source in the realtimekit-ui repository and submit a pull request against the staging branch; the changes will automatically sync here upon the next release. */}
The main grid component which abstracts all the grid handling logic and renders it for you.
Properties
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
aspectRatio |
string |
✅ | - | The aspect ratio of each participant |
config |
UIConfig |
❌ | createDefaultConfig() |
Config object |
gap |
number |
✅ | - | Gap between participants |
gridSize |
GridSize |
✅ | - | Grid size |
iconPack |
IconPack |
❌ | defaultIconPack |
Icon pack |
layout |
GridLayout |
✅ | - | Grid Layout |
meeting |
Meeting |
✅ | - | Meeting object |
overrides |
any |
✅ | - | Deprecated |
size |
Size |
✅ | - | Size |
states |
States |
✅ | - | States |
t |
RtkI18n |
❌ | useLanguage() |
Language |
Usage Examples
Basic Usage
<!-- component.html -->
<rtk-grid></rtk-grid>
With Properties
<!-- component.html -->
<rtk-grid
aspectRatio="example"
gap="42"
gridSize="md">
</rtk-grid>
这篇文档对你有帮助吗?
谢谢你的反馈!