@livekit/components-styles - npm Package Compare versions

Comparing version 0.1.4 to 0.1.5

dist/types_unprefixed/components/_index.scss.d.ts

 export type Styles = {
+  'audio-visualizer': string;
   button: string;
@@ -6,2 +7,3 @@ 'button-group': string;
   'button-menu': string;
+  'chat-toggle-button': string;
   'connection-quality': string;
@@ -11,8 +13,16 @@ 'device-menu': string;
   'disconnect-button': string;
+  'focus-toggle-button': string;
+  'lk-rotate': string;
   'media-device-select': string;
   'participant-media-audio': string;
   'participant-media-video': string;
+  'participant-metadata': string;
+  'participant-metadata-item': string;
   'participant-name': string;
-  'participant-view': string;
+  'participant-placeholder': string;
+  'participant-tile': string;
+  'room-container': string;
+  spinner: string;
   'start-audio-button': string;
+  toast: string;
   'track-muted-indicator-camera': string;
@@ -19,0 +29,0 @@ 'track-muted-indicator-microphone': string;

dist/types_unprefixed/layout-components/_focus-layout.scss.d.ts

 export type Styles = {
   'focus-layout': string;
+  'focus-layout-wrapper': string;
   'focused-participant': string;
@@ -4,0 +5,0 @@ 'pip-track': string;

dist/types_unprefixed/layout-components/_grid-layout.scss.d.ts

 export type Styles = {
   'grid-layout': string;
+  'grid-layout-wrapper': string;
 };
@@ -4,0 +5,0 @@

dist/types_unprefixed/layout-components/_index.scss.d.ts

 export type Styles = {
   'focus-layout': string;
+  'focus-layout-wrapper': string;
   'focused-participant': string;
   'grid-layout': string;
+  'grid-layout-wrapper': string;
   'pip-track': string;
@@ -6,0 +8,0 @@ };

dist/types_unprefixed/layout.scss.d.ts

 export type Styles = {
   'focus-layout': string;
+  'focus-layout-wrapper': string;
   'focused-participant': string;
   'grid-layout': string;
+  'grid-layout-wrapper': string;
   'pip-track': string;
@@ -6,0 +8,0 @@ };

dist/types_unprefixed/prefab-components/_index.scss.d.ts

 export type Styles = {
+  'audio-conference': string;
   'audio-container': string;
+  button: string;
+  'button-group': string;
   'button-group-container': string;
@@ -14,2 +17,3 @@ 'camera-off-note': string;
   'video-conference': string;
+  'video-conference-inner': string;
 };
@@ -16,0 +20,0 @@

dist/types_unprefixed/prefab-components/_prejoin.scss.d.ts

 export type Styles = {
   'audio-container': string;
+  button: string;
+  'button-group': string;
   'button-group-container': string;
@@ -4,0 +6,0 @@ 'camera-off-note': string;

dist/types_unprefixed/prefab-components/_video-conference.scss.d.ts

 export type Styles = {
   'video-conference': string;
+  'video-conference-inner': string;
 };
@@ -4,0 +5,0 @@

dist/types_unprefixed/prefabs.scss.d.ts

 export type Styles = {
+  'audio-conference': string;
   'audio-container': string;
+  button: string;
+  'button-group': string;
   'button-group-container': string;
@@ -14,2 +17,3 @@ 'camera-off-note': string;
   'video-conference': string;
+  'video-conference-inner': string;
 };
@@ -16,0 +20,0 @@

dist/types_unprefixed/styles.scss.d.ts

 export type Styles = {
+  'audio-visualizer': string;
   button: string;
@@ -6,2 +7,3 @@ 'button-group': string;
   'button-menu': string;
+  'chat-toggle-button': string;
   'connection-quality': string;
@@ -11,8 +13,17 @@ 'device-menu': string;
   'disconnect-button': string;
+  'focus-toggle-button': string;
+  'form-control': string;
+  'lk-rotate': string;
   'media-device-select': string;
   'participant-media-audio': string;
   'participant-media-video': string;
+  'participant-metadata': string;
+  'participant-metadata-item': string;
   'participant-name': string;
-  'participant-view': string;
+  'participant-placeholder': string;
+  'participant-tile': string;
+  'room-container': string;
+  spinner: string;
   'start-audio-button': string;
+  toast: string;
   'track-muted-indicator-camera': string;
@@ -19,0 +30,0 @@ 'track-muted-indicator-microphone': string;

dist/types/general/layout.css.d.ts

 export type Styles = {
   'lk-focus-layout': string;
+  'lk-focus-layout-wrapper': string;
   'lk-focused-participant': string;
   'lk-grid-layout': string;
+  'lk-grid-layout-wrapper': string;
   'lk-pip-track': string;
@@ -6,0 +8,0 @@ };

dist/types/general/prefabs.css.d.ts

 export type Styles = {
+  'lk-audio-conference': string;
   'lk-audio-container': string;
+  'lk-button': string;
+  'lk-button-group': string;
   'lk-button-group-container': string;
@@ -14,2 +17,3 @@ 'lk-camera-off-note': string;
   'lk-video-conference': string;
+  'lk-video-conference-inner': string;
 };
@@ -16,0 +20,0 @@

dist/types/general/styles.css.d.ts

 export type Styles = {
+  'lk-audio-visualizer': string;
   'lk-button': string;
@@ -6,2 +7,3 @@ 'lk-button-group': string;
   'lk-button-menu': string;
+  'lk-chat-toggle-button': string;
   'lk-connection-quality': string;
@@ -11,8 +13,17 @@ 'lk-device-menu': string;
   'lk-disconnect-button': string;
+  'lk-focus-toggle-button': string;
+  'lk-form-control': string;
   'lk-media-device-select': string;
   'lk-participant-media-audio': string;
   'lk-participant-media-video': string;
+  'lk-participant-metadata': string;
+  'lk-participant-metadata-item': string;
   'lk-participant-name': string;
-  'lk-participant-view': string;
+  'lk-participant-placeholder': string;
+  'lk-participant-tile': string;
+  'lk-room-container': string;
+  'lk-rotate': string;
+  'lk-spinner': string;
   'lk-start-audio-button': string;
+  'lk-toast': string;
   'lk-track-muted-indicator-camera': string;
@@ -19,0 +30,0 @@ 'lk-track-muted-indicator-microphone': string;

package.json

 {
   "name": "@livekit/components-styles",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "author": "LiveKit",
@@ -12,4 +12,4 @@ "license": "MIT",
     },
-    "./icons/*": {
-      "default": "./icons/*"
+    "./assets/icons/*": {
+      "default": "./assets/icons/*"
     },
@@ -16,0 +16,0 @@ "./layout": "./dist/general/layout.css",

README.md

@@ -10,2 +10,5 @@ # LiveKit Components **Styles**
 - [Home](/README.md)
+- **Docs**
+  - [Docs](/docs/alpha-docs/README.md)
+  - [Storybook](/docs/storybook/README.md)
 - **Framework Implementations**:
@@ -23,2 +26,22 @@ - [React](/packages/react/README.md)
 
+#### Prefix
+
+To avoid collisions CSS all CSS selector used for LiveKit Components (classes, CSS variables, and custom data attributes) are given the same prefix. To avoid typing redundant prefixes and keep the door open for user-defined prefixes, we use PostCSS plugins (see [postcss.config.js](postcss.config.js)) to add the prefix during the build step. This means that you should never write a prefix inside this styles package.
+
+The PostCSS plugins transform the CSS selectors as follows, to make it easier to understand here are a few examples with a prefix of "lk":
+
+| no prefix               | with `lk` prefix           |
+| ----------------------- | -------------------------- |
+| `.button`               | `.lk-button`               |
+| `--border-color`        | `--lk-border-color`        |
+| `var(--fg)`             | `var(--lk-fg)`             |
+| `[data-active='false']` | `[data-lk-active='false']` |
+| `&[data-muted='true']`  | `&[data-lk-muted='true']`  |
+
+#### ⚠️ Currently not supported prefix:
+
+| no prefix                     | with `lk` prefix                 |
+| ----------------------------- | -------------------------------- |
+| `attr(data-participant-name)` | `attr(data-lk-participant-name)` |
+
 #### `@include` vs `@extend`
@@ -29,1 +52,5 @@
 The compiled css output would suggest to use `@extend` in cases where css classes should inherit from parent classes (e.g. `.disconnect-button` inherits base properties from `.button`).
+
+```
+
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

51107

increased by3.38%

Number of package files

72

increased by5.88%

Lines of code

423

increased by34.29%

Number of lines in readme file

54

increased by100%

No dependency changes