chore: component docs

twilio-labs · Sep 28, 2023 · dc24e0d · dc24e0d
1 parent 63e78c4
commit dc24e0d
Show file tree

Hide file tree

Showing 50 changed files with 3,516 additions and 1,355 deletions.
diff --git a/packages/paste-codemods/tools/.cache/mappings.json b/packages/paste-codemods/tools/.cache/mappings.json
@@ -33,6 +33,7 @@
   "Callout": "@twilio-paste/core/callout",
   "CalloutHeading": "@twilio-paste/core/callout",
   "CalloutList": "@twilio-paste/core/callout",
+  "CalloutListItem": "@twilio-paste/core/callout",
   "CalloutText": "@twilio-paste/core/callout",
   "Card": "@twilio-paste/core/card",
   "ChatComposer": "@twilio-paste/core/chat-composer",

diff --git a/packages/paste-core/components/alert-dialog/type-docs.json b/packages/paste-core/components/alert-dialog/type-docs.json
@@ -2,42 +2,42 @@
   "AlertDialog": {
     "heading": {
       "type": "string",
-      "defaultValue": "null",
+      "defaultValue": null,
       "required": true,
       "externalProp": false,
       "description": "Header for the Alert Dialog"
     },
     "isOpen": {
       "type": "boolean",
-      "defaultValue": "null",
+      "defaultValue": null,
       "required": true,
       "externalProp": false,
       "description": "Determines whether the Alert Dialog is open"
     },
     "onConfirm": {
       "type": "() => void",
-      "defaultValue": "null",
+      "defaultValue": null,
       "required": true,
       "externalProp": false,
       "description": "Function to run when the confirm button is used"
     },
     "onConfirmLabel": {
       "type": "string",
-      "defaultValue": "null",
+      "defaultValue": null,
       "required": true,
       "externalProp": false,
       "description": "Label for the confirm button"
     },
     "onDismiss": {
       "type": "() => void",
-      "defaultValue": "null",
+      "defaultValue": null,
       "required": true,
       "externalProp": false,
       "description": "Function to run when the dismiss button is used"
     },
     "onDismissLabel": {
       "type": "string",
-      "defaultValue": "null",
+      "defaultValue": null,
       "required": true,
       "externalProp": false,
       "description": "Label for the dismiss button"

diff --git a/packages/paste-core/components/alert/type-docs.json b/packages/paste-core/components/alert/type-docs.json
@@ -2,7 +2,7 @@
   "Alert": {
     "variant": {
       "type": "AlertVariants",
-      "defaultValue": "null",
+      "defaultValue": null,
       "required": true,
       "externalProp": false
     },
@@ -422,7 +422,7 @@
     },
     "element": {
       "type": "string",
-      "defaultValue": "'Alert'",
+      "defaultValue": "'ALERT'",
       "required": false,
       "externalProp": false,
       "description": "Overrides the default element name to apply unique styles with the Customization Provider"

diff --git a/packages/paste-core/components/avatar/type-docs.json b/packages/paste-core/components/avatar/type-docs.json
@@ -2,7 +2,7 @@
   "Avatar": {
     "name": {
       "type": "string",
-      "defaultValue": "null",
+      "defaultValue": null,
       "required": true,
       "externalProp": false,
       "description": "Used to determine the initials, alt text (if using an image), or title (if using an icon) of the Avatar."
@@ -443,7 +443,7 @@
     },
     "icon": {
       "type": "FC<PropsWithChildren<GenericIconProps>>",
-      "defaultValue": "null",
+      "defaultValue": null,
       "required": false,
       "externalProp": false,
       "description": "Pass a Paste Icon to display in the Avatar"

diff --git a/packages/paste-core/components/callout/package.json b/packages/paste-core/components/callout/package.json
@@ -3,7 +3,7 @@
   "version": "4.0.0",
   "category": "feedback",
   "status": "production",
-  "description": "A callout is highlighted information in a larger page.",
+  "description": "A Callout is a banner that highlights important information on a page.",
   "author": "Twilio Inc.",
   "license": "MIT",
   "main:dev": "src/index.tsx",

diff --git a/packages/paste-core/components/callout/src/CalloutList.tsx b/packages/paste-core/components/callout/src/CalloutList.tsx
@@ -46,6 +46,13 @@ CalloutList.displayName = 'CalloutList';
 
 export interface CalloutListItemProps extends Partial<Omit<HTMLLIElement, 'children'>> {
   children?: React.ReactNode;
+  /**
+   * Overrides the default element name to apply unique styles with the Customization Provider
+   *
+   * @default 'CALLOUT_LIST_ITEM'
+   * @type {BoxProps['element']}
+   * @memberof CalloutListProps
+   */
   element?: BoxProps['element'];
 }
 

diff --git a/packages/paste-core/components/callout/src/index.tsx b/packages/paste-core/components/callout/src/index.tsx
@@ -4,5 +4,7 @@ export {CalloutHeading} from './CalloutHeading';
 export type {CalloutHeadingProps} from './CalloutHeading';
 export {CalloutList} from './CalloutList';
 export type {CalloutListProps} from './CalloutList';
+export {CalloutListItem} from './CalloutList';
+export type {CalloutListItemProps} from './CalloutList';
 export {CalloutText} from './CalloutText';
 export type {CalloutTextProps} from './CalloutText';