Skip to content

Commit

Permalink
chore: api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@SiTaggart
SiTaggart committed Nov 10, 2023
1 parent 5d6aa8f commit 4c543dc
Show file tree
Hide file tree
Showing 164 changed files with 49,234 additions and 8,047 deletions.
32 changes: 31 additions & 1 deletion cypress/integration/sitemap-vrt/constants.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,21 +160,47 @@ export const SITEMAP = [
"/components/progress-steps/api",
"/components/progress-steps/changelog",
"/components/radio-group/",
"/components/radio-group/api",
"/components/radio-group/changelog",
"/components/radio-button-group/",
"/components/radio-button-group/api",
"/components/radio-button-group/changelog",
"/components/screen-reader-only/",
"/components/screen-reader-only/api",
"/components/screen-reader-only/changelog",
"/components/select/",
"/components/select/api",
"/components/select/changelog",
"/components/separator/",
"/components/separator/api",
"/components/separator/changelog",
"/components/sidebar/",
"/components/sidebar/api",
"/components/sidebar/changelog",
"/components/sidebar-navigation/",
"/components/sidebar-navigation/api",
"/components/sidebar-navigation/changelog",
"/components/stack/",
"/components/stack/api",
"/components/stack/changelog",
"/components/status-badge/",
"/components/status-badge/api",
"/components/status-badge/changelog",
"/components/status-menu/",
"/components/status-menu/api",
"/components/status-menu/changelog",
"/components/spinner/",
"/components/spinner/api",
"/components/spinner/changelog",
"/components/skeleton-loader/",
"/components/skeleton-loader/api",
"/components/skeleton-loader/changelog",
"/components/slider/",
"/components/slider/api",
"/components/slider/changelog",
"/components/switch/",
"/components/switch/api",
"/components/switch/changelog",
"/components/tabs/",
"/components/tabs/api",
"/components/tabs/changelog",
Expand Down Expand Up @@ -261,7 +287,12 @@ export const SITEMAP = [
"/primitives/modal-dialog-primitive/",
"/primitives/non-modal-dialog-primitive/",
"/primitives/tabs-primitive/",
"/primitives/box/",
"/primitives/box/api",
"/primitives/box/changelog",
"/primitives/text/",
"/primitives/text/api",
"/primitives/text/changelog",
"/primitives/tooltip-primitive/",
"/primitives/listbox-primitive/",
"/roadmap/",
Expand All @@ -270,7 +301,6 @@ export const SITEMAP = [
"/theme/dark-theme/",
"/tokens/design-tokens-package/",
"/tokens/",
"/primitives/box/",
];

const SITEMAP_CHUNKS: string[][] = [];
Expand Down
3 changes: 0 additions & 3 deletions packages/paste-codemods/tools/.cache/mappings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,6 @@
"Select": "@twilio-paste/core/select",
"SelectElement": "@twilio-paste/core/select",
"Separator": "@twilio-paste/core/separator",
"AnimatedBox": "@twilio-paste/core/side-modal",
"SideModal": "@twilio-paste/core/side-modal",
"SideModalBody": "@twilio-paste/core/side-modal",
"SideModalButton": "@twilio-paste/core/side-modal",
Expand Down Expand Up @@ -294,7 +293,6 @@
"Stack": "@twilio-paste/core/stack",
"BOX_PROPS_TO_BLOCK": "@twilio-paste/core/box",
"Box": "@twilio-paste/core/box",
"StyledBox": "@twilio-paste/core/box",
"getCustomElementStyles": "@twilio-paste/core/box",
"safelySpreadBoxProps": "@twilio-paste/core/box",
"ComboboxPrimitive": "@twilio-paste/core/combobox-primitive",
Expand Down Expand Up @@ -326,7 +324,6 @@
"TabPrimitiveList": "@twilio-paste/core/tabs-primitive",
"TabPrimitivePanel": "@twilio-paste/core/tabs-primitive",
"useTabPrimitiveState": "@twilio-paste/core/tabs-primitive",
"StyledText": "@twilio-paste/core/text",
"TEXT_PROPS_TO_BLOCK": "@twilio-paste/core/text",
"Text": "@twilio-paste/core/text",
"safelySpreadTextProps": "@twilio-paste/core/text",
Expand Down
1 change: 0 additions & 1 deletion packages/paste-codemods/tools/__tests__/tools.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ describe("generatePackageExportsMap", () => {
DisclosurePrimitive: "@twilio-paste/core/disclosure-primitive",

Check warning on line 40 in packages/paste-codemods/tools/__tests__/tools.spec.ts

View workflow job for this annotation

GitHub Actions / Lint repository 

Define a constant instead of duplicating this literal 3 times
DisclosurePrimitiveContent: "@twilio-paste/core/disclosure-primitive",
Stack: "@twilio-paste/core/stack",
StyledBox: "@twilio-paste/core/box",
getCustomElementStyles: "@twilio-paste/core/box",
safelySpreadBoxProps: "@twilio-paste/core/box",
useComboboxPrimitive: "@twilio-paste/core/combobox-primitive",
Expand Down
72 changes: 48 additions & 24 deletions packages/paste-core/components/anchor/type-docs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,8 @@
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `column-gap` property"
},
"contentEditable": {
"type": "Booleanish | \"inherit\"",
Expand Down Expand Up @@ -425,7 +426,8 @@
"type": "| Display\n | (Display | null | undefined)[]\n | { [x: string]: Display | undefined; [x: number]: Display | undefined }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive style prop for the CSS `display` property"
},
"download": {
"type": "any",
Expand All @@ -450,7 +452,8 @@
"type": "| string\n | number\n | (string & {})\n | (HeightOptions | null)[]\n | { [x: string]: HeightOptions; [x: number]: HeightOptions }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive style prop of Size Tokens for for the CSS `height` property"
},
"hidden": {
"type": "boolean",
Expand Down Expand Up @@ -543,55 +546,64 @@
"type": "\"auto\" | \"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | ... 28 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `margin` property"
},
"marginBottom": {
"type": "\"auto\" | \"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | ... 28 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `margin-bottom` property"
},
"marginLeft": {
"type": "\"auto\" | \"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | ... 28 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `margin-left` property"
},
"marginRight": {
"type": "\"auto\" | \"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | ... 28 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `margin-right` property"
},
"marginTop": {
"type": "\"auto\" | \"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | ... 28 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `margin-top` property"
},
"marginX": {
"type": "\"auto\" | \"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | ... 28 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `margin-left` and `margin-right` properties"
},
"marginY": {
"type": "\"auto\" | \"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | ... 28 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `margin-top` and `margin-bottom` properties"
},
"maxHeight": {
"type": "| string\n | number\n | (string & {})\n | (MaxHeightOptions | null)[]\n | { [x: string]: MaxHeightOptions; [x: number]: MaxHeightOptions }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive style prop of Size Tokens for for the CSS `max-height` property"
},
"maxWidth": {
"type": "| string\n | number\n | (string & {})\n | (MaxWidthOptions | null)[]\n | { [x: string]: MaxWidthOptions; [x: number]: MaxWidthOptions }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive style prop of Size Tokens for for the CSS `max-width` property"
},
"media": {
"type": "string",
Expand All @@ -603,13 +615,15 @@
"type": "| string\n | number\n | (string & {})\n | (MinHeightOptions | null)[]\n | { [x: string]: MinHeightOptions; [x: number]: MinHeightOptions }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive style prop of Size Tokens for for the CSS `min-height` property"
},
"minWidth": {
"type": "| string\n | number\n | (string & {})\n | (MinWidthOptions | null)[]\n | { [x: string]: MinWidthOptions; [x: number]: MinWidthOptions }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive style prop of Size Tokens for for the CSS `min-width` property"
},
"nonce": {
"type": "string",
Expand Down Expand Up @@ -1611,43 +1625,50 @@
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding` property"
},
"paddingBottom": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-bottom` property"
},
"paddingLeft": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-left` property"
},
"paddingRight": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-right` property"
},
"paddingTop": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-top` property"
},
"paddingX": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-left` and `padding-right` properties"
},
"paddingY": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-top` and `padding-bottom` properties"
},
"ping": {
"type": "string",
Expand Down Expand Up @@ -1733,7 +1754,8 @@
"type": "string | number | (string & {}) | (WidthOptions | null)[] | { [x: string]: WidthOptions; [x: number]: WidthOptions; } | (HeightOptions | null)[] | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive style prop of Size Tokens for for the CSS `width` and `height` properties"
},
"slot": {
"type": "string",
Expand Down Expand Up @@ -1814,7 +1836,8 @@
"type": "VerticalAlign<0 | (string & {})> | (VerticalAlign<0 | (string & {})> | null | undefined)[] | { [x: string]: VerticalAlign<0 | (string & {})> | undefined; [x: number]: VerticalAlign<...> | undefined; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive style prop for the CSS `vertical-align` property"
},
"vocab": {
"type": "string",
Expand All @@ -1826,7 +1849,8 @@
"type": "| string\n | number\n | (string & {})\n | (WidthOptions | null)[]\n | { [x: string]: WidthOptions; [x: number]: WidthOptions }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive style prop of Size Tokens for the CSS `width` property"
}
}
}
21 changes: 14 additions & 7 deletions packages/paste-core/components/card/type-docs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1477,43 +1477,50 @@
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding` property"
},
"paddingBottom": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-bottom` property"
},
"paddingLeft": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-left` property"
},
"paddingRight": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-right` property"
},
"paddingTop": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-top` property"
},
"paddingX": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-left` and `padding-right` properties"
},
"paddingY": {
"type": "\"space0\" | \"space10\" | \"space20\" | \"space30\" | \"space40\" | \"space50\" | \"space60\" | \"space70\" | \"space80\" | \"space90\" | \"space100\" | \"space110\" | \"space120\" | \"space130\" | \"space140\" | ... 27 more ... | { ...; }",
"defaultValue": null,
"required": false,
"externalProp": false
"externalProp": false,
"description": "Responsive prop of Space tokens for the CSS `padding-top` and `padding-bottom` properties"
},
"placeholder": {
"type": "string",
Expand Down
Loading

0 comments on commit 4c543dc

Please sign in to comment.