Skip to content

Commit

Permalink
chore: component api docs r-s (#3607)
Browse files Browse the repository at this point in the history
* chore: checkin

* chore: api docs

* chore: minor type corrections

* chore: changeset

* chore: pr feedback and changesets

* chore: missing types

* chore: broken link, thanks broken link checker

* chore: no longer need a changelog revealer test
  • Loading branch information
SiTaggart committed Nov 16, 2023
1 parent 3d5d1db commit b97c052
Show file tree
Hide file tree
Showing 217 changed files with 119,068 additions and 2,671 deletions.
6 changes: 6 additions & 0 deletions .changeset/bright-worms-heal.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/list": patch
"@twilio-paste/core": patch
---

[List] remove `listStyleType` from Ordered and Unordered List type signature as it is not passed to the underlying component
6 changes: 6 additions & 0 deletions .changeset/fifty-waves-reflect.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/codemods": patch
"@twilio-paste/core": patch
---

[codemods]: Updated exports map
13 changes: 13 additions & 0 deletions .changeset/quiet-dodos-act.md
@@ -0,0 +1,13 @@
---
"@twilio-paste/combobox-primitive": patch
"@twilio-paste/disclosure-primitive": patch
"@twilio-paste/listbox-primitive": patch
"@twilio-paste/menu-primitive": patch
"@twilio-paste/modal-dialog-primitive": patch
"@twilio-paste/non-modal-dialog-primitive": patch
"@twilio-paste/tabs-primitive": patch
"@twilio-paste/tooltip-primitive": patch
"@twilio-paste/core": patch
---

Updated dev depenedencies to include typescript and tsx for running build scripts
6 changes: 6 additions & 0 deletions .changeset/real-paws-build.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/data-grid": patch
"@twilio-paste/core": patch
---

[Data Grid]: Re-add SortDirection type export
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/style-props": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock1.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/icons": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock10.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/sidebar": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock11.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/side-modal": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock12.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/separator": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock13.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/select": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock14.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/screen-reader-only": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock15.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/radio-group": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock16.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/radio-button-group": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock17.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/inline-control-group": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock2.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/text": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock3.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/sibling-box": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock4.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/box": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock5.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/switch": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock6.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/status": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock7.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/spinner": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock8.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/slider": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
6 changes: 6 additions & 0 deletions .changeset/thick-lamps-knock9.md
@@ -0,0 +1,6 @@
---
"@twilio-paste/skeleton-loader": patch
"@twilio-paste/core": patch
---

Improved TsDoc type annotations
1 change: 0 additions & 1 deletion cypress/integration/e2e/primitives/box.spec.ts
Expand Up @@ -14,6 +14,5 @@ describe("Box primitives documentation page", () => {
cy.checkInPageNavigationLinks();
cy.checkPageAside();
cy.checkLivePreviews();
cy.checkChangelogRevealer();
});
});
32 changes: 31 additions & 1 deletion cypress/integration/sitemap-vrt/constants.ts
Expand Up @@ -161,21 +161,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 @@ -262,7 +288,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 @@ -271,7 +302,6 @@ export const SITEMAP = [
"/theme/dark-theme/",
"/tokens/design-tokens-package/",
"/tokens/",
"/primitives/box/",
];

const SITEMAP_CHUNKS: string[][] = [];
Expand Down
10 changes: 0 additions & 10 deletions cypress/support/commands/parent-commands.ts
Expand Up @@ -78,16 +78,6 @@ Cypress.Commands.add("checkDoDonts", () => {
cy.getDocsPageContentArea().find('[data-cy="dont-box"]').and("have.length.above", 0);
});

Cypress.Commands.add("checkChangelogRevealer", () => {
cy.getInFixedContainer("#component-changelog")
.as("changelogContainer")
.contains("h2", "Changelog")
.should("be.visible")
.click(); // Note: when cypress is upgraded, we can specify ScrollBehavior here to center if not default

cy.get("@changelogContainer").find('[data-cy="changelog-revealer-content"]').should("be.visible");
});

Cypress.Commands.add("getInFixedContainer", (selector) => {
cy.get(selector).as("target");

Expand Down
2 changes: 1 addition & 1 deletion nx.json
Expand Up @@ -49,7 +49,7 @@
]
},
"build:typedocs": {
"dependsOn": ["^build:typedocs", "^tsc"],
"dependsOn": ["^build:typedocs"],
"outputs": ["{projectRoot}/type-docs.json"]
},
"tsc": {
Expand Down
3 changes: 0 additions & 3 deletions packages/paste-codemods/tools/.cache/mappings.json
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
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, test, build and publish or release

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

0 comments on commit b97c052

Please sign in to comment.