doc(snackbar): write a example for snackbarSignal Method

the-nexim · Dec 16, 2024 · 09877f4 · 09877f4
1 parent 8f8b745
commit 09877f4
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/packages/snackbar/src/lib/handler.ts b/packages/snackbar/src/lib/handler.ts
@@ -36,6 +36,22 @@ export const snackbarActionButtonClickedSignal = new AlwatrTrigger({
 
 /**
  * Signal for displaying the snackbar.
+ *
+ * @example
+ * import {snackbarSignal} from '@nexim/snackbar';
+ *
+ * snackbarSignal.notify({
+ *   content: 'This is a snackbar message',
+ *   // The following properties are optional.
+ *   action: {
+ *     label: 'Undo',
+ *     handler: () => {
+ *       console.log('Action button clicked');
+ *     },
+ *   },
+ *   duration: '4s',
+ *   addCloseButton: true,
+ * });
  */
 export const snackbarSignal = new AlwatrSignal<SnackbarOptions>({name: 'snackbar'});