diff --git a/web-components/packages/carbon-web-components/.storybook/theme.ts b/web-components/packages/carbon-web-components/.storybook/theme.ts index 97e7c6c44d74..e6773c1421fd 100644 --- a/web-components/packages/carbon-web-components/.storybook/theme.ts +++ b/web-components/packages/carbon-web-components/.storybook/theme.ts @@ -15,6 +15,7 @@ export default create({ fontBase: "'IBM Plex Sans', 'Helvetica Neue', Arial, sans-serif", fontCode: "'IBM Plex Mono', Menlo, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', Courier, monospace", - brandTitle: `carbon-web-components ${version}`, - brandUrl: 'https://github.com/carbon-design-system/carbon-web-components', + brandTitle: `@carbon/web-components ${version}`, + brandUrl: + 'https://github.com/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components', } as ThemeVars); diff --git a/web-components/packages/carbon-web-components/CHANGELOG.md b/web-components/packages/carbon-web-components/CHANGELOG.md index df3a9fd1b0fb..49c3c9bc9bc2 100644 --- a/web-components/packages/carbon-web-components/CHANGELOG.md +++ b/web-components/packages/carbon-web-components/CHANGELOG.md @@ -3,6 +3,239 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.30.0-rc.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.29.0...@carbon/web-components@1.30.0-rc.0) (2023-07-11) + + +### Bug Fixes + +* **date-picker:** prevent range inputs from clearing prematurely ([#10603](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10603)) ([77306c8](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/77306c89d2b5d374efdafba99b77e50cf65f61b7)) +* **masthead:** Esc to close Cloud Masthead ([#10555](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10555)) ([de67bf8](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/de67bf8242ff47f2c26f285fc878f932bc822397)), closes [#10174](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10174) + + + + + +# [1.29.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.29.0-rc.3...@carbon/web-components@1.29.0) (2023-06-27) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.29.0-rc.3](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.29.0-rc.2...@carbon/web-components@1.29.0-rc.3) (2023-06-27) + + +### Bug Fixes + +* **multi-select:** move filterable attribute out of scope for styles ([#10608](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10608)) ([1c1cf35](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/1c1cf35ced1d73c9b0558ce474edd124ce773da8)) + + + + + +# [1.29.0-rc.2](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.29.0-rc.1...@carbon/web-components@1.29.0-rc.2) (2023-06-23) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.29.0-rc.1](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.29.0-rc.0...@carbon/web-components@1.29.0-rc.1) (2023-06-22) + + +### Bug Fixes + +* **masthead:** Esc to close Cloud Masthead ([#10555](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10555)) ([#10588](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10588)) ([06cd69d](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/06cd69dec6d91cafb358e078d8d083ae62edfc13)), closes [#10174](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10174) + + + + + +# [1.29.0-rc.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.28.0...@carbon/web-components@1.29.0-rc.0) (2023-06-09) + + +### Bug Fixes + +* **bx-header-menu:** add button role ([#10440](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10440)) ([c5d8c5d](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/c5d8c5db8c42e129a901cda81aba7eeadb5f8c79)), closes [#10392](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10392) +* **input:** autocomplete property ([#10540](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10540)) ([6096958](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/60969585cc3792409e967784437fefd2bf096c71)), closes [#10498](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10498) +* **modal:** small screen view ([#10511](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10511)) ([7f4aaef](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/7f4aaef392fa7b3482b3544a4b0b7833034ccf33)) + + + + + +# [1.28.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.28.0-rc.2...@carbon/web-components@1.28.0) (2023-05-23) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.28.0-rc.2](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.28.0-rc.1...@carbon/web-components@1.28.0-rc.2) (2023-05-18) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.28.0-rc.1](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.28.0-rc.0...@carbon/web-components@1.28.0-rc.1) (2023-05-11) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.28.0-rc.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.27.0-rc.0...@carbon/web-components@1.28.0-rc.0) (2023-05-08) + + +### Bug Fixes + +* **checkbox:** set relative `position` ([#10333](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10333)) ([8f10b78](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/8f10b78cc1543ca6f2e69339be96a0974bc79631)) + + + + + +# [1.27.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.27.0-rc.1...@carbon/web-components@1.27.0) (2023-04-25) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.27.0-rc.1](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.27.0-rc.0...@carbon/web-components@1.27.0-rc.1) (2023-04-18) + + +### Bug Fixes + +* **checkbox:** set relative `position` ([#10333](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10333)) ([8f10b78](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/8f10b78cc1543ca6f2e69339be96a0974bc79631)) + + + + + +# [1.27.0-rc.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.26.0...@carbon/web-components@1.27.0-rc.0) (2023-04-11) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.26.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.26.0-rc.3...@carbon/web-components@1.26.0) (2023-03-28) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.26.0-rc.3](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.26.0-rc.2...@carbon/web-components@1.26.0-rc.3) (2023-03-27) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.26.0-rc.2](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.26.0-rc.1...@carbon/web-components@1.26.0-rc.2) (2023-03-23) + + +### Bug Fixes + +* **modal:** styles with sass upgrade ([#10237](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10237)) ([46993a9](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/46993a90bcb072ae77d07ea63e672821e9bdf628)) + + + + + +# [1.26.0-rc.1](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.26.0-rc.0...@carbon/web-components@1.26.0-rc.1) (2023-03-16) + + +### Bug Fixes + +* **notificaiton/breadcrumb:** update styles/remove [@extend](https://github.com/extend) ([#10231](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10231)) ([96affe7](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/96affe7426a988e00f75e2313651a76ff095b162)) + + + + + +# [1.26.0-rc.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.25.0...@carbon/web-components@1.26.0-rc.0) (2023-03-13) + + +### Bug Fixes + +* **cwc:** storybook link ([#10194](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10194)) ([ea4d0a6](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/ea4d0a6c11859effef23b6aa073918dad41ce3de)) +* **date-picker:** range mode clearing first value ([#10168](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10168)) ([fe4d6da](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/fe4d6dabc2ee15953de62c7d12d72d1329756b39)), closes [#10088](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10088) +* **lightbox-carousel:** accessibility & QA improvements to lightbox carousels ([#9149](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9149)) ([fa408af](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/fa408afb43e47d3c0c1259a33a47c637bedb0fac)), closes [#8911](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8911) [#8913](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8913) [#8915](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8915) [#8912](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8912) [#8914](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8914) [#8911](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8911) [#8912](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8912) [/github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/main/packages/web-components/src/components/expressive-modal/expressive-modal.ts#L358](https://github.com//github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/main/packages/web-components/src/components/expressive-modal/expressive-modal.ts/issues/L358) [#8913](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8913) [#8914](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8914) [#8915](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8915) +* **storybook:** fix cwc cdn link docs ([#10189](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10189)) ([8656e2e](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/8656e2e84bcb48a7fe6d00d6ae66e4830650a10d)) +* **tile:** fix expanable content visibility ([#10203](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10203)) ([a71b9f9](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/a71b9f9c74b854851511cad3de98f47aea46cc36)), closes [#10202](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10202) +* **tooltip:** adjust focus to div within tooltip-body ([#10217](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/10217)) ([9d4a326](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/9d4a326257c869ecf7d4d1288af99a9ef8373144)) + + + + + +# [1.25.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.25.0-rc.0...@carbon/web-components@1.25.0) (2023-02-28) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.25.0-rc.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.24.0...@carbon/web-components@1.25.0-rc.0) (2023-02-10) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.24.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.24.0-rc.1...@carbon/web-components@1.24.0) (2023-01-31) + +**Note:** Version bump only for package @carbon/web-components + + + + + +# [1.24.0-rc.1](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.24.0-rc.0...@carbon/web-components@1.24.0-rc.1) (2023-01-31) + + +### Bug Fixes + +* **styles:** downgrade sass version as there is an issue with [@extend](https://github.com/extend) ([#9973](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9973)) ([8cff8a9](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/8cff8a9fb8b926dff5089497ea41a423c97d7e73)) + + + + + +# [1.24.0-rc.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.23.0...@carbon/web-components@1.24.0-rc.0) (2023-01-25) + + +### Bug Fixes + +* **bx-dropdown:** prevent interactivity while disabled ([#9881](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9881)) ([5fe8471](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/5fe84714b109b2cebb1cde06cf88eeb22da6baf5)), closes [#9754](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9754) +* **masthead:** update logo url protocol ([#9914](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9914)) ([ece8c04](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/ece8c0426bb222341b2ddd423498fcb9b899e7dc)), closes [#9567](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9567) +* **styles:** add missing styles for breadcrumb and modal ([#9942](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9942)) ([9a90ea1](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/9a90ea15de00b182dd3795f820ef525cd1809a4e)), closes [#9936](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9936) [#9923](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9923) +* **tooltip:** close tooltip on escape or focusout ([#9871](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9871)) ([3fdd70e](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/3fdd70e85627fcf1d704b1dbb316771050ca6047)), closes [#8996](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/8996) + + +### Features + +* **tile:** add custom event to `selected-tile` ([#9898](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9898)) ([11fe5bf](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/commit/11fe5bfb03ded3c766e10245b03406c846bb03bd)), closes [#9740](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/issues/9740) + + + + + # [1.23.0](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/compare/@carbon/web-components@1.23.0-rc.0...@carbon/web-components@1.23.0) (2023-01-17) **Note:** Version bump only for package @carbon/web-components diff --git a/web-components/packages/carbon-web-components/carbon.yml b/web-components/packages/carbon-web-components/carbon.yml new file mode 100644 index 000000000000..a8df1597a2e0 --- /dev/null +++ b/web-components/packages/carbon-web-components/carbon.yml @@ -0,0 +1,581 @@ +# yaml-language-server: $schema=https://unpkg.com/@carbon-platform/schemas@v1/carbon-resources.schema.json +library: + id: carbon-web-components + name: Carbon Web Components + description: Build user interfaces with web components based on Carbon's React library. + externalDocsUrl: https://www.ibm.com/standards/web/carbon-for-ibm-dotcom + inherits: carbon-styles + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components + navData: + - title: Get started + path: 'https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/developing/frameworks/web-components.mdx' +assets: + accordion: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/accordion/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-accordion + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/accordion/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/accordion/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/accordion/accessibility.mdx + overviewPath: ./src/components/accordion/docs/overview.mdx + breadcrumb: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/breadcrumb/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-breadcrumb + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/breadcrumb/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/breadcrumb/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/breadcrumb/accessibility.mdx + overviewPath: ./src/components/breadcrumb/docs/overview.mdx + button: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/button/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-button + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/button/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/button/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/button/accessibility.mdx + overviewPath: ./src/components/button/docs/overview.mdx + checkbox: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/checkbox/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-checkbox + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/checkbox/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/checkbox/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/checkbox/accessibility.mdx + overviewPath: ./src/components/checkbox/docs/overview.mdx + code-snippet: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/code-snippet/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-code-snippet + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/code-snippet/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/code-snippet/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/code-snippet/accessibility.mdx + overviewPath: ./src/components/code-snippet/docs/overview.mdx + combo-box: + status: stable + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-combo-box + docs: + overviewPath: ./src/components/combo-box/docs/overview.mdx + content-switcher: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/content-switcher/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-content-switcher + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/content-switcher/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/content-switcher/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/content-switcher/accessibility.mdx + overviewPath: ./src/components/content-switcher/docs/overview.mdx + copy-button: + status: stable + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-copy-button + docs: + overviewPath: ./src/components/copy-button/docs/overview.mdx + data-table: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/data-table/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-data-table + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/data-table/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/data-table/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/data-table/accessibility.mdx + overviewPath: ./src/components/data-table/docs/overview.mdx + date-picker: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/date-picker/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-date-picker + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/date-picker/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/date-picker/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/date-picker/accessibility.mdx + overviewPath: ./src/components/date-picker/docs/overview.mdx + dropdown: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/dropdown/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-dropdown + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/dropdown/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/dropdown/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/dropdown/accessibility.mdx + overviewPath: ./src/components/dropdown/docs/overview.mdx + file-uploader: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/file-uploader/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-file-uploader + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/file-uploader/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/file-uploader/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/file-uploader/accessibility.mdx + overviewPath: ./src/components/file-uploader/docs/overview.mdx + icon: + name: Icon + framework: web-component + status: stable + type: component + platform: web + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-icon + thumbnailPath: "./thumbnails/icon.svg" + tags: + - media + - content-element + docs: + overviewPath: ./src/components/icon/docs/overview.mdx + inline-loading: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/inline-loading/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-inline-loading + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/inline-loading/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/inline-loading/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/inline-loading/accessibility.mdx + overviewPath: ./src/components/inline-loading/docs/overview.mdx + input: + name: Input + status: stable + type: component + framework: web-component + platform: web + thumbnailPath: "./thumbnails/input.svg" + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-input + tags: + - input-control + docs: + overviewPath: ./src/components/input/docs/overview.mdx + link: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/link/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-link + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/link/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/link/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/link/accessibility.mdx + overviewPath: ./src/components/link/docs/overview.mdx + list: + status: stable + externalDocsUrl: https://carbondesignsystem.com/components/list/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-list + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/list/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/list/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/list/accessibility.mdx + overviewPath: ./src/components/list/docs/overview.mdx + loading: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/loading/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-loading + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/loading/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/loading/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/loading/accessibility.mdx + overviewPath: ./src/components/loading/docs/overview.mdx + modal: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/modal/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-modal + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/modal/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/modal/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/modal/accessibility.mdx + overviewPath: ./src/components/modal/docs/overview.mdx + multiselect: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/dropdown/usage/#multiselect + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-multi-select + docs: + overviewPath: ./src/components/multi-select/docs/overview.mdx + notification: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/notification/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-notifications + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/notification/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/notification/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/notification/accessibility.mdx + overviewPath: ./src/components/notification/docs/overview.mdx + number-input: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/number-input/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-number-input + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/number-input/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/number-input/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/number-input/accessibility.mdx + overviewPath: ./src/components/number-input/docs/overview.mdx + overflow-menu: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/overflow-menu/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-overflow-menu + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/overflow-menu/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/overflow-menu/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/overflow-menu/accessibility.mdx + overviewPath: ./src/components/overflow-menu/docs/overview.mdx + pagination: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/pagination/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-pagination + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/pagination/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/pagination/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/pagination/accessibility.mdx + overviewPath: ./src/components/pagination/docs/overview.mdx + progress-indicator: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/progress-indicator/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-progress-indicator + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/progress-indicator/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/progress-indicator/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/progress-indicator/accessibility.mdx + overviewPath: ./src/components/progress-indicator/docs/overview.mdx + radio-button: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/radio-button/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-radio-button + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/radio-button/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/radio-button/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/radio-button/accessibility.mdx + overviewPath: ./src/components/radio-button/docs/overview.mdx + search: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/search/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-search + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/search/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/search/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/search/accessibility.mdx + overviewPath: ./src/components/search/docs/overview.mdx + select: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/select/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-select + tags: + - shell + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/select/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/select/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/select/accessibility.mdx + overviewPath: ./src/components/select/docs/overview.mdx + skeleton-placeholder: + name: Skeleton placeholder + status: stable + type: component + platform: web + framework: web-component + thumbnailPath: './thumbnails/skeleton-placeholder.svg' + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-skeleton-placeholder + tags: + - system-feedback + docs: + overviewPath: ./src/components/skeleton-placeholder/docs/overview.mdx + skeleton-text: + name: Skeleton text + status: stable + type: component + platform: web + framework: web-component + thumbnailPath: './thumbnails/skeleton-text.svg' + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-skeleton-text + tags: + - shell + docs: + overviewPath: ./src/components/skeleton-text/docs/overview.mdx + skip-to-content: + name: Skip to content + type: component + platform: web + status: stable + framework: web-component + thumbnailPath: './thumbnails/skip-to-content.svg' + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-skip-to-content + tags: + - contextual-navigation + docs: + overviewPath: ./src/components/skip-to-content/docs/overview.mdx + slider: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/slider/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-slider + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/slider/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/slider/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/slider/accessibility.mdx + overviewPath: ./src/components/slider/docs/overview.mdx + structured-list: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/structured-list/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-structured-list + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/structured-list/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/structured-list/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/structured-list/accessibility.mdx + overviewPath: ./src/components/structured-list/docs/overview.mdx + tabs: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/tabs/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-tabs + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tabs/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tabs/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tabs/accessibility.mdx + overviewPath: ./src/components/tabs/docs/overview.mdx + tag: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/tag/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-tag + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tag/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tag/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tag/accessibility.mdx + overviewPath: ./src/components/tag/docs/overview.mdx + text-area: + status: stable + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-textarea + docs: + overviewPath: ./src/components/textarea/docs/overview.mdx + tile: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/tile/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-tile + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tile/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tile/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tile/accessibility.mdx + overviewPath: ./src/components/tile/docs/overview.mdx + toggle: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/toggle/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-toggle + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/toggle/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/toggle/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/toggle/accessibility.mdx + overviewPath: ./src/components/toggle/docs/overview.mdx + tooltip: + status: stable + externalDocsUrl: https://www.carbondesignsystem.com/components/tooltip/usage + framework: web-component + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-tooltip + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tooltip/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tooltip/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/tooltip/accessibility.mdx + overviewPath: ./src/components/tooltip/docs/overview.mdx + ui-shell: + name: UI shell + type: component + platform: web + framework: web-component + thumbnailPath: './thumbnails/ui-shell.svg' + externalDocsUrl: https://www.carbondesignsystem.com/components/UI-shell-header/usage + status: stable + demoLinks: + - type: storybook + name: Storybook + action: link + url: https://www.ibm.com/standards/carbon/carbon-web-components/?path=/docs/components-ui-shell + tags: + - contextual-navigation + docs: + usagePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/UI-shell-header/usage.mdx + stylePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/UI-shell-header/style.mdx + accessibilityPath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/UI-shell-header/accessibility.mdx + codePath: https://github.com/carbon-design-system/carbon-website/blob/carbon-platform/src/pages/components/UI-shell-header/code.mdx + overviewPath: ./src/components/ui-shell/docs/overview.mdx diff --git a/web-components/packages/carbon-web-components/docs/styling.md b/web-components/packages/carbon-web-components/docs/styling.md index f7143e1f68eb..6475c3c4adde 100644 --- a/web-components/packages/carbon-web-components/docs/styling.md +++ b/web-components/packages/carbon-web-components/docs/styling.md @@ -1,8 +1,6 @@ # Using custom styles in components -As Shadow DOM (one of the Web Components specs that `carbon-web-components` -uses) promises, styles that `carbon-web-components` defines does not affect -styles in your application, or vice versa. +As Shadow DOM (one of the Web Components specs that `@carbon/web-components` uses) promises, styles that `@carbon/web-components` defines does not affect styles in your application, or vice versa. However, in cases where your application or a Carbon-derived style guide wants to change the styles of our components, there are a few options. diff --git a/web-components/packages/carbon-web-components/docs/welcome-story.mdx b/web-components/packages/carbon-web-components/docs/welcome-story.mdx index 57e32da58517..fa930b8cb1b0 100644 --- a/web-components/packages/carbon-web-components/docs/welcome-story.mdx +++ b/web-components/packages/carbon-web-components/docs/welcome-story.mdx @@ -17,31 +17,31 @@ A Carbon Design System variant that's as easy to use as native HTML elements, wi > contributors.

- + Carbon is released under the Apache-2.0 license

-# `carbon-web-components` +# `@carbon/web-components` -`carbon-web-components` is a variant of Carbon Design System with Custom Elements v1 and Shadow DOM v1 specs. +`@carbon/web-components` is a variant of Carbon Design System with Custom Elements v1 and Shadow DOM v1 specs. The effort stems from https://github.com/carbon-design-system/issue-tracking/issues/121. If you are interested in this project, adding 👍 to the description of that GH issue, or even contributing, will be greatly appreciated! ## Getting started -To install `carbon-web-components` in your project, you will need to run the +To install `@carbon/web-components` in your project, you will need to run the following command using [npm](https://www.npmjs.com/): ```bash -npm install --save carbon-web-components +npm install --save @carbon/web-components ``` If you prefer [Yarn](https://yarnpkg.com/en/), use the following command instead: ```bash -yarn add carbon-web-components +yarn add @carbon/web-components ``` ### Basic usage @@ -83,8 +83,8 @@ If you just want to try our components for demnstrations and so on, you can use