@snapcall/stream-ui 1.0.0 → 1.3.0

package/README.md

@@ -52,6 +52,10 @@ Terminates the room, all participants will be disconnected and the room won't be
 
 Generate a room token with a SnapCall button ID.
 
+### `sendNotification(message: string, options: NotificationOptions): void`
+
+Send a notification (tooltip), see [NotificationOptions](#notificationoptions) for the options.
+
 ## API
 
 ### `InitOptions`
@@ -71,32 +75,32 @@ Generate a room token with a SnapCall button ID.
 }
 ```
 
-### `element`
+#### `element`
 
 ##### **Required**
 
 The HTML element where the UI will be rendered.
 
-### `sharedURL`
+#### `sharedURL`
 
 ##### Default value: `window.location.href`
 
-The URL used for features such as "Open new tab" or "QR Code".
+The URL used for features such as "Open new tab" or "Quick Connect".
 
-### `audioTiles`
+#### `audioTiles`
 
 ##### Default value: `false`
 
 Enable audio-only tiles.
 
-### `settingsShortcuts`
+#### `settingsShortcuts`
 
 ##### Default value: `[]`
 
 Specified options are added as a small shortcut next to the menu button.
-Possible values are: `openNewTab`, `copyLink`, `qrCode`, `settings` and `pip`.
+Possible values are: `openNewTab`, `copyLink`, `quickConnect`, `settings` and `pip`.
 
-### `controls`
+#### `controls`
 
 Allows to manage the available and enabled devices
 
@@ -125,8 +129,32 @@ type Device = 'microphone' | 'camera' | 'screenshare';
 
 ##### Default value: `{ available: true, enabled: false }`
 
-### `showMenuButton`
+#### `showMenuButton`
 
 ##### Default value: `true`
 
 Display or hide the top-right menu button
+
+### `NotificationOptions`
+
+```ts
+interface NotificationOptions {
+  icon?: JSX.Element | string;
+  subText?: string;
+  button?: {
+    icon?: JSX.Element | string;
+    text: string;
+    action: ({ close }: { close: () => void }) => void;
+  };
+  status?: {
+    icon?: JSX.Element | string;
+    text?: string;
+    boldText?: string;
+  };
+  width?: string;
+  backgroundColor?: string;
+  messageStyle?: React.CSSProperties;
+  ellipsis?: boolean;
+  duration?: number;
+}
+```