@carbon/ibm-products-web-components 0.18.0 → 0.19.0

package/custom-elements.json

@@ -105,6 +105,16 @@
           "name": "size",
           "type": "number"
         },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
         {
           "name": "customElements",
           "type": "CustomElementRegistry | undefined"
@@ -247,6 +257,289 @@
         }
       ]
     },
+    {
+      "name": "c4p-notification-footer",
+      "path": "./src/components/notification-panel/notification-footer.ts",
+      "description": "Notification Footer.",
+      "attributes": [
+        {
+          "name": "view-all-label",
+          "description": "Label for View All Text",
+          "type": "string",
+          "default": "\"View All\""
+        }
+      ],
+      "properties": [
+        {
+          "name": "viewAllLabel",
+          "attribute": "view-all-label",
+          "description": "Label for View All Text",
+          "type": "string",
+          "default": "\"View All\""
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        },
+        {
+          "name": "size",
+          "type": "number"
+        },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "customElements",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "registry",
+          "type": "CustomElementRegistry | undefined"
+        }
+      ],
+      "events": [
+        {
+          "name": "c4p-notification-view-all",
+          "description": "The custom event is fired when a user clicks on View All button."
+        },
+        {
+          "name": "c4p-notification-settings",
+          "description": "The custom event is fired when User clicks on settings button."
+        }
+      ]
+    },
+    {
+      "name": "c4p-notification-panel",
+      "path": "./src/components/notification-panel/notification-panel.ts",
+      "description": "NotificationPanel.",
+      "attributes": [
+        {
+          "name": "title-text",
+          "description": "Sets the Title for the Notification panel"
+        },
+        {
+          "name": "today-text",
+          "description": "Sets the Today text for the Notification panel"
+        },
+        {
+          "name": "previous-text",
+          "description": "Sets the Previous section title for the Notification panel"
+        },
+        {
+          "name": "open",
+          "description": "Determines whether the notifications panel should render or not",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "dismiss-all-label",
+          "description": "Sets the label text for the \"Dismiss all\" button in the Notification panel"
+        },
+        {
+          "name": "donot-disturb-label",
+          "description": "Sets the label text for the \"Do Not Disturb\" toggle in the Notification panel"
+        },
+        {
+          "name": "triggerButtonRef",
+          "description": "Reference to the trigger button",
+          "type": "HTMLElement | undefined"
+        },
+        {
+          "name": "date-time-locale",
+          "description": "The language for each notification's time stamp.\nUsed with `dateTimeStyle`.",
+          "type": "string | undefined"
+        }
+      ],
+      "properties": [
+        {
+          "name": "titleText",
+          "attribute": "title-text",
+          "description": "Sets the Title for the Notification panel"
+        },
+        {
+          "name": "todayText",
+          "attribute": "today-text",
+          "description": "Sets the Today text for the Notification panel"
+        },
+        {
+          "name": "previousText",
+          "attribute": "previous-text",
+          "description": "Sets the Previous section title for the Notification panel"
+        },
+        {
+          "name": "open",
+          "attribute": "open",
+          "description": "Determines whether the notifications panel should render or not",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "dismissAllLabel",
+          "attribute": "dismiss-all-label",
+          "description": "Sets the label text for the \"Dismiss all\" button in the Notification panel"
+        },
+        {
+          "name": "doNotDisturbLabel",
+          "attribute": "donot-disturb-label",
+          "description": "Sets the label text for the \"Do Not Disturb\" toggle in the Notification panel"
+        },
+        {
+          "name": "triggerButtonRef",
+          "attribute": "triggerButtonRef",
+          "description": "Reference to the trigger button",
+          "type": "HTMLElement | undefined"
+        },
+        {
+          "name": "dateTimeLocale",
+          "attribute": "date-time-locale",
+          "description": "The language for each notification's time stamp.\nUsed with `dateTimeStyle`.",
+          "type": "string | undefined"
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        },
+        {
+          "name": "size",
+          "type": "number"
+        },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "customElements",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "registry",
+          "type": "CustomElementRegistry | undefined"
+        }
+      ],
+      "events": [
+        {
+          "name": "c4p-notification-panel-beingclosed",
+          "description": "The custom event before notification-panel is closed."
+        },
+        {
+          "name": "c4p-notification-dismiss-all",
+          "description": "The custom event fired after notification-panel is closed upon a user gesture."
+        },
+        {
+          "name": "c4p-notification-donot-disturb-change",
+          "description": "The custom event fired after notification-panel is closed upon a user gesture."
+        },
+        {
+          "name": "c4p-notification-click-outside",
+          "description": "The custom event fired after user clicks outside the panel or Esc key is pressed."
+        }
+      ],
+      "slots": [
+        {
+          "name": "today",
+          "description": "Today Section."
+        },
+        {
+          "name": "previous",
+          "description": "Previous Section."
+        },
+        {
+          "name": "footer",
+          "description": "Footer for the Panel."
+        }
+      ]
+    },
+    {
+      "name": "c4p-notification",
+      "path": "./src/components/notification-panel/notification.ts",
+      "description": "Notification.",
+      "attributes": [
+        {
+          "name": "type",
+          "description": "Sets the type of notification to display: 'error', 'warning', 'success', or 'informational'",
+          "type": "\"error\" | \"warning\" | \"success\" | \"informational\" | undefined"
+        },
+        {
+          "name": "timestamp",
+          "description": "Sets the timestamp for the notification, typically used to indicate when it was received",
+          "type": "Date | undefined"
+        }
+      ],
+      "properties": [
+        {
+          "name": "type",
+          "attribute": "type",
+          "description": "Sets the type of notification to display: 'error', 'warning', 'success', or 'informational'",
+          "type": "\"error\" | \"warning\" | \"success\" | \"informational\" | undefined"
+        },
+        {
+          "name": "timestamp",
+          "attribute": "timestamp",
+          "description": "Sets the timestamp for the notification, typically used to indicate when it was received",
+          "type": "Date | undefined"
+        },
+        {
+          "name": "dateTimeLocale",
+          "type": "string | undefined",
+          "default": "\"undefined\""
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        },
+        {
+          "name": "size",
+          "type": "number"
+        },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "customElements",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "registry",
+          "type": "CustomElementRegistry | undefined"
+        }
+      ],
+      "events": [
+        {
+          "name": "c4p-notification-dismiss",
+          "description": "The custom event is fired when the notification is closed by a user gesture."
+        }
+      ],
+      "slots": [
+        {
+          "name": "title",
+          "description": "The Title for the notification."
+        },
+        {
+          "name": "description",
+          "description": "The description for the notification."
+        }
+      ]
+    },
     {
       "name": "c4p-options-tile",
       "path": "./src/components/options-tile/options-tile.ts",
@@ -310,6 +603,16 @@
           "type": "\"lg\" | \"xl\" | undefined",
           "default": "\"lg\""
         },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
         {
           "name": "customElements",
           "type": "CustomElementRegistry | undefined"
@@ -336,6 +639,169 @@
         }
       ]
     },
+    {
+      "name": "c4p-page-header-breadcrumb",
+      "path": "./src/components/page-header/page-header-breadcrumb.ts",
+      "description": "Page header Breadcrumb Bar.",
+      "attributes": [
+        {
+          "name": "border",
+          "description": "Specify if breadcrumb bar has bottom border.",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "within-grid",
+          "description": "Set to `true` if the breadcrumb bar is sitting within a grid\n(ie. when used in tandem with page-header-hero-image)",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "page-actions-flush",
+          "description": "Set to `true` if page actions should be flush (no padding)",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "content-actions-flush",
+          "description": "Set to `true` if content actions should be flush (no padding)",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "border",
+          "attribute": "border",
+          "description": "Specify if breadcrumb bar has bottom border.",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "withinGrid",
+          "attribute": "within-grid",
+          "description": "Set to `true` if the breadcrumb bar is sitting within a grid\n(ie. when used in tandem with page-header-hero-image)",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "pageActionsFlush",
+          "attribute": "page-actions-flush",
+          "description": "Set to `true` if page actions should be flush (no padding)",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "contentActionsFlush",
+          "attribute": "content-actions-flush",
+          "description": "Set to `true` if content actions should be flush (no padding)",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "c4p-page-header-content-text",
+      "path": "./src/components/page-header/page-header-content-text.ts",
+      "description": "Page header Content Text.",
+      "attributes": [
+        {
+          "name": "subtitle",
+          "description": "Subtitle text of the page-header-content",
+          "type": "string",
+          "default": "\"\""
+        }
+      ],
+      "properties": [
+        {
+          "name": "subtitle",
+          "attribute": "subtitle",
+          "description": "Subtitle text of the page-header-content",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "c4p-page-header-content",
+      "path": "./src/components/page-header/page-header-content.ts",
+      "description": "Page header content.",
+      "attributes": [
+        {
+          "name": "title",
+          "description": "Title text of the page-header-content",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "within-grid",
+          "description": "Set to `true` if the breadcrumb bar is sitting within a grid\n(ie. when used in tandem with page-header-hero-image)",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "title",
+          "attribute": "title",
+          "description": "Title text of the page-header-content",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "withinGrid",
+          "attribute": "within-grid",
+          "description": "Set to `true` if the breadcrumb bar is sitting within a grid\n(ie. when used in tandem with page-header-hero-image)",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "c4p-page-header-hero-image",
+      "path": "./src/components/page-header/page-header-hero-image.ts",
+      "description": "Page header Hero Image.",
+      "properties": [
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "c4p-page-header-tabs",
+      "path": "./src/components/page-header/page-header-tabs.ts",
+      "description": "Page header Tabs Bar.",
+      "properties": [
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
+    {
+      "name": "c4p-page-header",
+      "path": "./src/components/page-header/page-header.ts",
+      "description": "Page header.",
+      "properties": [
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        }
+      ]
+    },
     {
       "name": "c4p-side-panel",
       "path": "./src/components/side-panel/side-panel.ts",
@@ -407,6 +873,12 @@
           "type": "string",
           "default": "\"\""
         },
+        {
+          "name": "hide-close-button",
+          "description": "Show/hide the \"X\" close button",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "slide-in",
           "description": "Determines if this panel slides in",
@@ -503,6 +975,13 @@
           "type": "string",
           "default": "\"\""
         },
+        {
+          "name": "hideCloseButton",
+          "attribute": "hide-close-button",
+          "description": "Show/hide the \"X\" close button",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "slideIn",
           "attribute": "slide-in",
@@ -526,6 +1005,16 @@
           "type": "SIDE_PANEL_SIZE",
           "default": "\"md\""
         },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
         {
           "name": "customElements",
           "type": "CustomElementRegistry | undefined"
@@ -683,6 +1172,16 @@
           "name": "size",
           "type": "number"
         },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
         {
           "name": "customElements",
           "type": "CustomElementRegistry | undefined"
@@ -1002,6 +1501,16 @@
           "attribute": "size",
           "description": "Set the size of the avatar circle"
         },
+        {
+          "name": "context-request",
+          "description": "A 'context-request' event can be emitted by any element which desires\na context value to be injected by an external provider.",
+          "type": "ContextRequestEvent<{ __context__: unknown; }>"
+        },
+        {
+          "name": "context-provider",
+          "description": "A 'context-provider' event can be emitted by any element which hosts\na context provider to indicate it is available for use.",
+          "type": "ContextProviderEvent<{ __context__: unknown; }>"
+        },
         {
           "name": "customElements",
           "type": "CustomElementRegistry | undefined"