@carbon/ibm-products-web-components 0.10.0 → 0.11.0-rc.1

package/custom-elements.json

@@ -1,6 +1,130 @@
 {
   "version": "experimental",
   "tags": [
+    {
+      "name": "c4p-about-modal",
+      "path": "./src/components/about-modal/about-modal.ts",
+      "description": "About Modal.",
+      "attributes": [
+        {
+          "name": "open",
+          "description": "Determines if About Modal is open or not.",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "closeIconDescription",
+          "description": "Determines if About Modal is open or not.",
+          "type": "string",
+          "default": "\"close\""
+        },
+        {
+          "name": "copyrightText",
+          "description": "Determines if About Modal is open or not."
+        },
+        {
+          "name": "logo",
+          "description": "A visual symbol used to represent the product."
+        },
+        {
+          "name": "version",
+          "description": "Text that provides information on the version number of your product."
+        },
+        {
+          "name": "title",
+          "description": "Header text that provides the product name. The IBM Services logo consists of two discrete, but required, elements: the iconic IBM 8-bar logo represented alongside the IBM Services logotype. Please follow these guidelines to ensure proper execution."
+        },
+        {
+          "name": "additionalInfo",
+          "description": "If you are legally required to display logos of technologies used to build your product you can provide this in the additionalInfo. Additional information will be displayed in the footer."
+        },
+        {
+          "name": "content",
+          "description": "Subhead text providing any relevant product disclaimers including legal information (optional)"
+        },
+        {
+          "name": "links",
+          "description": "An array of Carbon `Link` component if there are additional information to call out within the card. The about modal should be used to display the product information and not where users go to find help (optional)"
+        }
+      ],
+      "properties": [
+        {
+          "name": "open",
+          "attribute": "open",
+          "description": "Determines if About Modal is open or not.",
+          "type": "boolean",
+          "default": "true"
+        },
+        {
+          "name": "closeIconDescription",
+          "attribute": "closeIconDescription",
+          "description": "Determines if About Modal is open or not.",
+          "type": "string",
+          "default": "\"close\""
+        },
+        {
+          "name": "copyrightText",
+          "attribute": "copyrightText",
+          "description": "Determines if About Modal is open or not."
+        },
+        {
+          "name": "logo",
+          "attribute": "logo",
+          "description": "A visual symbol used to represent the product."
+        },
+        {
+          "name": "version",
+          "attribute": "version",
+          "description": "Text that provides information on the version number of your product."
+        },
+        {
+          "name": "title",
+          "attribute": "title",
+          "description": "Header text that provides the product name. The IBM Services logo consists of two discrete, but required, elements: the iconic IBM 8-bar logo represented alongside the IBM Services logotype. Please follow these guidelines to ensure proper execution."
+        },
+        {
+          "name": "additionalInfo",
+          "attribute": "additionalInfo",
+          "description": "If you are legally required to display logos of technologies used to build your product you can provide this in the additionalInfo. Additional information will be displayed in the footer."
+        },
+        {
+          "name": "content",
+          "attribute": "content",
+          "description": "Subhead text providing any relevant product disclaimers including legal information (optional)"
+        },
+        {
+          "name": "links",
+          "attribute": "links",
+          "description": "An array of Carbon `Link` component if there are additional information to call out within the card. The about modal should be used to display the product information and not where users go to find help (optional)"
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        },
+        {
+          "name": "size",
+          "type": "number"
+        },
+        {
+          "name": "customElements",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "registry",
+          "type": "CustomElementRegistry | undefined"
+        }
+      ],
+      "events": [
+        {
+          "name": "c4p-about-modal-beingclosed",
+          "description": "The custom event fired before this about modal is being closed upon a user gesture.\nCancellation of this event stops the user-initiated action of closing this about modal."
+        },
+        {
+          "name": "c4p-about-modal-closed",
+          "description": "The custom event fired after this about modal is closed upon a user gesture."
+        }
+      ]
+    },
     {
       "name": "c4p-side-panel",
       "path": "./src/components/side-panel/side-panel.ts",
@@ -190,6 +314,14 @@
           "description": "SidePanel size.",
           "type": "SIDE_PANEL_SIZE",
           "default": "\"md\""
+        },
+        {
+          "name": "customElements",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "registry",
+          "type": "CustomElementRegistry | undefined"
         }
       ],
       "events": [
@@ -339,6 +471,14 @@
         {
           "name": "size",
           "type": "number"
+        },
+        {
+          "name": "customElements",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "registry",
+          "type": "CustomElementRegistry | undefined"
         }
       ],
       "events": [
@@ -351,6 +491,116 @@
           "description": "The custom event fired after this tearsheet is closed upon a user gesture."
         }
       ]
+    },
+    {
+      "name": "c4p-user-avatar",
+      "path": "./src/components/user-avatar/user-avatar.ts",
+      "description": "Useravatar.",
+      "attributes": [
+        {
+          "name": "tooltip-text",
+          "description": "Specify the text of the tooltip.\nCan be string"
+        },
+        {
+          "name": "tooltip-alignment",
+          "description": "Specify the alignment of the tooltip.",
+          "type": "string",
+          "default": "\"bottom\""
+        },
+        {
+          "name": "name",
+          "description": "When passing the name prop, either send the initials to be used or the user's full name. The first two capital letters of the user's name will be used as the name."
+        },
+        {
+          "name": "renderIcon",
+          "description": "Provide a custom icon to use if you need to use an icon other than the default one"
+        },
+        {
+          "name": "image",
+          "description": "When passing the image prop, supply a full path to the image to be displayed."
+        },
+        {
+          "name": "image-description",
+          "description": "When passing the image prop use the imageDescription prop to describe the image for screen reader."
+        },
+        {
+          "name": "background-color",
+          "description": "Provide the background color need to be set for UserAvatar.",
+          "type": "string",
+          "default": "\"order-1-cyan\""
+        },
+        {
+          "name": "theme",
+          "description": "Set theme in which the component will be rendered."
+        },
+        {
+          "name": "size",
+          "description": "Set the size of the avatar circle"
+        }
+      ],
+      "properties": [
+        {
+          "name": "tooltipText",
+          "attribute": "tooltip-text",
+          "description": "Specify the text of the tooltip.\nCan be string"
+        },
+        {
+          "name": "tooltipAlignment",
+          "attribute": "tooltip-alignment",
+          "description": "Specify the alignment of the tooltip.",
+          "type": "string",
+          "default": "\"bottom\""
+        },
+        {
+          "name": "name",
+          "attribute": "name",
+          "description": "When passing the name prop, either send the initials to be used or the user's full name. The first two capital letters of the user's name will be used as the name."
+        },
+        {
+          "name": "renderIcon",
+          "attribute": "renderIcon",
+          "description": "Provide a custom icon to use if you need to use an icon other than the default one"
+        },
+        {
+          "name": "image",
+          "attribute": "image",
+          "description": "When passing the image prop, supply a full path to the image to be displayed."
+        },
+        {
+          "name": "imageDescription",
+          "attribute": "image-description",
+          "description": "When passing the image prop use the imageDescription prop to describe the image for screen reader."
+        },
+        {
+          "name": "backgroundColor",
+          "attribute": "background-color",
+          "description": "Provide the background color need to be set for UserAvatar.",
+          "type": "string",
+          "default": "\"order-1-cyan\""
+        },
+        {
+          "name": "theme",
+          "attribute": "theme",
+          "description": "Set theme in which the component will be rendered."
+        },
+        {
+          "name": "styles",
+          "default": "\"styles\""
+        },
+        {
+          "name": "size",
+          "attribute": "size",
+          "description": "Set the size of the avatar circle"
+        },
+        {
+          "name": "customElements",
+          "type": "CustomElementRegistry | undefined"
+        },
+        {
+          "name": "registry",
+          "type": "CustomElementRegistry | undefined"
+        }
+      ]
     }
   ]
 }