File tree Expand file tree Collapse file tree 2 files changed +32
-0
lines changed
packages/react/src/components/participant Expand file tree Collapse file tree 2 files changed +32
-0
lines changed Original file line number Diff line number Diff line change 1+ ---
2+ " @livekit/components-react " : patch
3+ ---
4+
5+ Add more usage examples for bar visualizer
Original file line number Diff line number Diff line change @@ -76,6 +76,33 @@ const getSequencerInterval = (
7676 * );
7777 * }
7878 * ```
79+ *
80+ * @example
81+ * Styling the BarVisualizer using CSS classes
82+ * ```css
83+ * .lk-audio-bar {
84+ * // Styles for "idle" bars
85+ * }
86+ * .lk-audio-bar.lk-highlighted {
87+ * // Styles for "active" bars
88+ * }
89+ * ```
90+ *
91+ * @example
92+ * Styling the BarVisualizer using CSS custom properties
93+ * ```css
94+ * --lk-fg // for the "active" colour, note that this defines the main foreground colour for the whole "theme"
95+ * --lk-va-bg // for "idle" colour
96+ * ```
97+ *
98+ * @example
99+ * Using a custom bar template for the BarVisualizer
100+ * ```tsx
101+ * <BarVisualizer>
102+ * <div className="all the classes" />
103+ * </BarVisualizer>
104+ * ```
105+ * the highlighted children will get a data prop of data-lk-highlighted for them to switch between active and idle bars in their own template bar
79106 */
80107export const BarVisualizer = /* @__PURE__ */ React . forwardRef < HTMLDivElement , BarVisualizerProps > (
81108 function BarVisualizer (
You can’t perform that action at this time.
0 commit comments