chore: pr feedback

twilio-labs · Oct 3, 2023 · a4a7b13 · a4a7b13
1 parent 58c3181
commit a4a7b13
Show file tree

Hide file tree

Showing 22 changed files with 80 additions and 62 deletions.
diff --git a/.changeset/flat-worms-explode.md b/.changeset/flat-worms-explode.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/heading': minor
-'@twilio-paste/core': minor
+'@twilio-paste/heading': patch
+'@twilio-paste/core': patch
 ---
 
 [Heading]: Improved TsDoc type annotations
diff --git a/.changeset/giant-gorillas-behave.md b/.changeset/giant-gorillas-behave.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/data-grid': minor
-'@twilio-paste/core': minor
+'@twilio-paste/data-grid': patch
+'@twilio-paste/core': patch
 ---
 
 [Data Grid]: Improved TsDoc type annotation
diff --git a/.changeset/green-deers-attend.md b/.changeset/green-deers-attend.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/editable-code-block': minor
-'@twilio-paste/core': minor
+'@twilio-paste/editable-code-block': patch
+'@twilio-paste/core': patch
 ---
 
 [Editable Code Block]: Improved TsDoc type annotations
diff --git a/.changeset/healthy-laws-marry.md b/.changeset/healthy-laws-marry.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/form': minor
-'@twilio-paste/core': minor
+'@twilio-paste/form': patch
+'@twilio-paste/core': patch
 ---
 
 [Form]: Improved TsDoc type annotations
diff --git a/.changeset/lazy-hats-report.md b/.changeset/lazy-hats-report.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/display-heading': minor
-'@twilio-paste/core': minor
+'@twilio-paste/display-heading': patch
+'@twilio-paste/core': patch
 ---
 
 [Display Heading]: Improved TsDoc type annotations
diff --git a/.changeset/light-buttons-type.md b/.changeset/light-buttons-type.md
@@ -1,5 +1,6 @@
 ---
 '@twilio-paste/codemods': minor
+'@twilio-paste/core': minor
 ---
 
 [Codemods] New exports from icons package
diff --git a/.changeset/mean-pugs-dream.md b/.changeset/mean-pugs-dream.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/display-pill-group': minor
-'@twilio-paste/core': minor
+'@twilio-paste/display-pill-group': patch
+'@twilio-paste/core': patch
 ---
 
 [Display Pill Group]: Improved TsDoc type annotations
diff --git a/.changeset/perfect-shoes-kneel.md b/.changeset/perfect-shoes-kneel.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/description-list': minor
-'@twilio-paste/core': minor
+'@twilio-paste/description-list': patch
+'@twilio-paste/core': patch
 ---
 
 [Description List] Improved TsDoc type annotations
diff --git a/.changeset/purple-oranges-tease.md b/.changeset/purple-oranges-tease.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/date-picker': minor
-'@twilio-paste/core': minor
+'@twilio-paste/date-picker': patch
+'@twilio-paste/core': patch
 ---
 
 [Date Picker]: Improved TsDoc type annotation
diff --git a/.changeset/rare-pillows-sleep.md b/.changeset/rare-pillows-sleep.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/help-text': minor
-'@twilio-paste/core': minor
+'@twilio-paste/help-text': patch
+'@twilio-paste/core': patch
 ---
 
 [Healp Text]: Improved TsDoc type annotations
diff --git a/.changeset/shaggy-flies-laugh.md b/.changeset/shaggy-flies-laugh.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/file-picker': minor
-'@twilio-paste/core': minor
+'@twilio-paste/file-picker': patch
+'@twilio-paste/core': patch
 ---
 
 [File Picker]: Improved TsDoc type annotations
diff --git a/.changeset/short-mirrors-call.md b/.changeset/short-mirrors-call.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/form-pill-group': minor
-'@twilio-paste/core': minor
+'@twilio-paste/form-pill-group': patch
+'@twilio-paste/core': patch
 ---
 
 [Form Pill Group]: Improved TsDoc type annotations
diff --git a/.changeset/six-pots-enjoy.md b/.changeset/six-pots-enjoy.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/disclosure': minor
-'@twilio-paste/core': minor
+'@twilio-paste/disclosure': patch
+'@twilio-paste/core': patch
 ---
 
 [Disclosure]: Improved TsDoc type annotations
diff --git a/.changeset/warm-bears-peel.md b/.changeset/warm-bears-peel.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/file-uploader': minor
-'@twilio-paste/core': minor
+'@twilio-paste/file-uploader': patch
+'@twilio-paste/core': patch
 ---
 
 [File Uploader]: Improved TsDoc type annotations
diff --git a/.changeset/wicked-mice-join.md b/.changeset/wicked-mice-join.md
@@ -1,6 +1,6 @@
 ---
-'@twilio-paste/detail-text': minor
-'@twilio-paste/core': minor
+'@twilio-paste/detail-text': patch
+'@twilio-paste/core': patch
 ---
 
 [Detail Text]: Improved TsDoc type annotations
diff --git a/packages/paste-core/components/data-grid/type-docs.json b/packages/paste-core/components/data-grid/type-docs.json
@@ -546,7 +546,7 @@
     },
     "noWrap": {
       "type": "boolean",
-      "defaultValue": null,
+      "defaultValue": "'false'",
       "required": false,
       "externalProp": false,
       "description": "Sets the table cells to not line wrap."
@@ -1573,7 +1573,7 @@
     },
     "scrollHorizontally": {
       "type": "boolean",
-      "defaultValue": null,
+      "defaultValue": "'false'",
       "required": false,
       "externalProp": false,
       "description": "Sets the table to scroll horizontally on small screens."
@@ -1598,7 +1598,7 @@
     },
     "striped": {
       "type": "boolean",
-      "defaultValue": null,
+      "defaultValue": "'false'",
       "required": false,
       "externalProp": false,
       "description": "Sets a background color for even rows within the table."
@@ -1629,10 +1629,10 @@
     },
     "tableLayout": {
       "type": "TableLayoutOptions",
-      "defaultValue": null,
+      "defaultValue": "'auto'",
       "required": false,
       "externalProp": false,
-      "description": "Sets the `table-layout` style of the Table. Defaults to `auto`."
+      "description": "Sets the `table-layout` style of the Table."
     },
     "title": {
       "type": "string",
@@ -1660,10 +1660,10 @@
     },
     "variant": {
       "type": "TableVariantOptions",
-      "defaultValue": null,
+      "defaultValue": "'default'",
       "required": false,
       "externalProp": false,
-      "description": "Sets the `border` style of the Table. Defaults to `default`."
+      "description": "Sets the `border` style of the Table."
     },
     "vocab": {
       "type": "string",
@@ -4881,10 +4881,10 @@
     },
     "textAlign": {
       "type": "TableAlignmentOptions",
-      "defaultValue": null,
+      "defaultValue": "'left'",
       "required": false,
       "externalProp": false,
-      "description": "Sets the text alignment of the content within the Table cell. Defaults to `left`."
+      "description": "Sets the text alignment of the content within the Table cell."
     },
     "title": {
       "type": "string",
@@ -6575,10 +6575,10 @@
     },
     "textAlign": {
       "type": "TableAlignmentOptions",
-      "defaultValue": null,
+      "defaultValue": "'left'",
       "required": false,
       "externalProp": false,
-      "description": "Sets the text alignment of the content within the Table cell. Defaults to `left`."
+      "description": "Sets the text alignment of the content within the Table cell."
     }
   },
   "DataGridFoot": {

diff --git a/packages/paste-core/components/disclosure/src/Disclosure.tsx b/packages/paste-core/components/disclosure/src/Disclosure.tsx
@@ -17,11 +17,17 @@ export interface DisclosureProps extends DisclosurePrimitiveInitialState {
    */
   element?: BoxProps["element"];
   children: NonNullable<React.ReactNode>;
+  /**
+   * Provide the Disclosure state returned from `useDisclosureState` if you want to control the state of the Disclosure.
+   *
+   * @type {DisclosureStateReturn}
+   * @memberof DisclosureProps
+   */
   state?: DisclosureStateReturn;
   /**
    * Changes the styling on the component based on the variant selected.
    *
-   *
+   * @default 'default'
    * @type {DisclosureVariants}
    * @memberof DisclosureProps
    */

diff --git a/packages/paste-core/components/disclosure/type-docs.json b/packages/paste-core/components/disclosure/type-docs.json
@@ -25,11 +25,12 @@
       "type": "DisclosureStateReturn",
       "defaultValue": null,
       "required": false,
-      "externalProp": false
+      "externalProp": false,
+      "description": "Provide the Disclosure state returned from `useDisclosureState` if you want to control the state of the Disclosure."
     },
     "variant": {
       "type": "DisclosureVariants",
-      "defaultValue": null,
+      "defaultValue": "'default'",
       "required": false,
       "externalProp": false,
       "description": "Changes the styling on the component based on the variant selected."

diff --git a/packages/paste-core/components/table/src/types.ts b/packages/paste-core/components/table/src/types.ts
@@ -31,30 +31,37 @@ export interface TableProps extends HTMLPasteProps<"table"> {
   /**
    * Sets a background color for even rows within the table.
    *
+   * @default 'false'
    * @type {boolean}
    * @memberof TableProps
    */
   striped?: boolean;
   /**
-   * Sets the `table-layout` style of the Table. Defaults to `auto`.
+   * Sets the `table-layout` style of the Table.
    *
+   * @default 'auto'
    * @type {TableLayoutOptions}
    * @memberof TableProps
    */
   tableLayout?: TableLayoutOptions;
   /**
-   * Sets the `border` style of the Table. Defaults to `default`.
+   * Sets the `border` style of the Table.
    *
+   * @default 'default'
    * @type {TableVariantOptions}
    * @memberof TableProps
    */
   variant?: TableVariantOptions;
   /**
    * Sets the table to scroll horizontally on small screens.
+   *
+   * @default 'false'
    */
   scrollHorizontally?: boolean;
   /**
    * Sets the table cells to not line wrap.
+   *
+   * @default 'false'
    */
   noWrap?: boolean;
   /**
@@ -106,8 +113,9 @@ export interface TrProps extends HTMLPasteProps<"tr"> {
    */
   element?: BoxProps["element"];
   /**
-   * Sets the vertical alignment of the content within the Table row. Defaults to `middle`.
+   * Sets the vertical alignment of the content within the Table row.
    *
+   * @default 'middle'
    * @type {TableVerticalAlignmentOptions}
    * @memberof TrProps
    */
@@ -124,8 +132,9 @@ export interface ThProps extends HTMLPasteProps<"th"> {
    */
   element?: BoxProps["element"];
   /**
-   * Sets the text alignment of the content within the Table cell. Defaults to `left`.
+   * Sets the text alignment of the content within the Table cell.
    *
+   * @default 'left'
    * @type {TableAlignmentOptions}
    * @memberof ThProps
    */
@@ -149,8 +158,9 @@ export interface TdProps extends HTMLPasteProps<"td"> {
    */
   element?: BoxProps["element"];
   /**
-   * Sets the text alignment of the content within the Table cell. Defaults to `left`.
+   * Sets the text alignment of the content within the Table cell.
    *
+   * @default 'left'
    * @type {TableAlignmentOptions}
    * @memberof TdProps
    */