rtk-settings-toggle

{/* 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-settings-toggle/rtk-settings-toggle.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. */}

A button which toggles visibility of settings module. When clicked it emits a rtkStateUpdate event with the data:

{ activeSettings: boolean; }

Properties

Usage Examples

Basic Usage

<!-- component.html -->
<rtk-settings-toggle></rtk-settings-toggle>

With Properties

<!-- component.html -->
<rtk-settings-toggle
 size="md"
 variant="button">
</rtk-settings-toggle>