\n \n \n \n \n \n Option 1\n Option 2\n Option 3\n Option 4\n Option 5\n \n
\n \n\n```\n\nOur example at [CodeSandbox](https://codesandbox.io) shows usage with only CDN\nartifacts:\n\n[](https://codesandbox.io/s/github/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components/examples/codesandbox/cdn)\n\n### Using ES imports\n\n#### How to install\n\nTo install `@carbon/web-components` in your project, you will need to run the\nfollowing command using [npm](https://www.npmjs.com/):\n\n```bash\nnpm install --save @carbon/web-components\n```\n\nIf you prefer [Yarn](https://yarnpkg.com/en/), use the following command\ninstead:\n\n```bash\nyarn add @carbon/web-components\n```\n\n> NOTE: Carbon and Lit dependencies will be managed by Carbon Web Components\n> starting in `v1.19.0`. For earlier versions, these dependencies will have to\n> be installed separately:\n>\n> npm:\n>\n> ```bash\n> npm install --save carbon-components lit-html lit-element\n> ```\n>\n> Yarn:\n>\n> ```bash\n> yarn add carbon-components lit-html lit-element\n> ```\n\n#### Basic usage\n\nOur example at [CodeSandbox](https://codesandbox.io) shows the most basic usage:\n\n[](https://codesandbox.io/s/github/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components/examples/codesandbox/basic)\n\nThe first thing you need is **setting up a module bundler** to resolve\nECMAScript `import`s. The above example uses [Webpack](https://webpack.js.org),\nbut you can use other bundlers like [Rollup](https://rollupjs.org/) too.\n\nOnce you set up a module bundler, you can start importing our component modules,\nfor example:\n\n```javascript\nimport '@carbon/web-components/es/components/dropdown/dropdown.js';\nimport '@carbon/web-components/es/components/dropdown/dropdown-item.js';\n```\n\nOnce you've imported the component modules, you can use our components in the\nsame manner as native HTML tags, for example:\n\n```html\n\n Option 1\n Option 2\n Option 3\n Option 4\n Option 5\n\n```\n\n### Other usage guides\n\n- [Having components participate in form](./docs/form.md)\n- [Using custom styles in components](./docs/styling.md)\n- [Using `carbon-web-components` with old build toolchain](./docs/old-build-toolchain.md)\n\n## JavaScript framework support\n\nIn addition to the available Web Component versions of Carbon components, this\nlibrary also supports usage with JavaScript frameworks like Angular, React, and\nVue if the desire is to use instead of the pure framework versions of Carbon\ncomponents. Specifically for React, this library comes with a wrapper\nimplementation around the Carbon Web Components for more seamless integration\nwith your React application.\n\nThis is achievable since Web Components is the modern browser standard, and\nworks well with other front-end frameworks that exist in the application. In\nturn, this also comes with the benefits of encapsulation within the Shadow DOM:\n\n### Angular\n\nAngular users can use our components in the same manner as native HTML tags,\ntoo, once you add\n[`CUSTOM_ELEMENTS_SCHEMA`](https://angular.io/api/core/CUSTOM_ELEMENTS_SCHEMA)\nschema to your Angular module, for example:\n\n```javascript\nimport { CUSTOM_ELEMENTS_SCHEMA, NgModule } from '@angular/core';\nimport { BrowserModule } from '@angular/platform-browser';\n\nimport { AppComponent } from './app.component';\n\n@NgModule({\n schemas: [CUSTOM_ELEMENTS_SCHEMA],\n declarations: [AppComponent],\n imports: [BrowserModule],\n bootstrap: [AppComponent],\n})\nexport class AppModule {}\n```\n\nThe `.d.ts` files in `@carbon/web-components` package are compiled with\nTypeScript 3.7. You can use TypeScript 3.7 in your Angular application with\nupcoming Angular `9.0` release, or with the following instructions, so your\napplication can use those `.d.ts` files:\n\n- Set `true` to\n [`angularCompilerOptions.disableTypeScriptVersionCheck`](https://angular.io/guide/angular-compiler-options#disabletypescriptversioncheck)\n in `tsconfig.json`\n- In `polyfills.ts`, change\n [`__importDefault` TypeScript helper](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#example-8)\n as follows:\n `window.__importDefault = mod => (mod?.__esModule ? mod : { default: mod })`\n\n### React\n\n[](https://codesandbox.io/s/github/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components/examples/codesandbox/react)\n\nYou can use wrapper React components in\n`@carbon/web-components/es/components-react` generated\n[automatically from the custom elements](./src/globals/wrappers/createReactCustomElementType.ts)\nwhich allows you to use our components seamlessly in your React code. Here's an\nexample:\n\n```javascript\nimport React from 'react';\nimport { render } from 'react-dom';\nimport CDSDropdown from '@carbon/web-components/es/components-react/dropdown/dropdown.js';\nimport CDSDropdownItem from '@carbon/web-components/es/components-react/dropdown/dropdown-item.js';\n\nconst App = () => (\n \n Option 1\n Option 2\n Option 3\n Option 4\n Option 5\n \n);\n\nrender(, document.getElementById('root'));\n```\n\nNote: Using the React wrapper requires an additional dependency,\n[`prop-types`](https://www.npmjs.com/package/prop-types).\n\nTo run the wrapper React components in SSR environment requires Node `12.16.3`\nor above that supports\n[\"conditional mapping\" feature](https://github.com/jkrems/proposal-pkg-exports#2-conditional-mapping):\n\n[](https://codesandbox.io/s/github/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components/examples/codesandbox/react-ssr)\n\nSame Node version requirement applies to Next.js:\n\n[](https://codesandbox.io/s/github/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components/examples/codesandbox/next)\n\n### Vue\n\n[](https://codesandbox.io/s/github/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components/examples/codesandbox/vue)\n\nVue users can use our components in the same manner as native HTML tags, without\nany additional steps!\n\n## Getting started with development\n\n1. Fork this repository and clone it\n2. `yarn install`\n3. `cd packages/carbon-web-components`\n4. `yarn wca && yarn storybook`\n\n## List of available components\n\nView available web components at:\nhttps://www.ibm.com/standards/carbon/carbon-web-components. You can see usage\ninformation in several ways:\n\n1. Going to Docs tab, where it shows the usage and available attributes,\n properties and custom events.\n2. Clicking the **KNOBS** tab at the bottom and changing values there. Most\n knobs are shown as something like `Button kind (kind)`, where `kind` is the\n attribute name\n3. Clicking the **ACTION LOGGER** tab at the bottom and interacting with the\n selected component. You may see something like `cds-modal-closed` which\n typically indicates that an event with such event type is fired. You can also\n expand the twistie to see the details of the event\n\n## Browser support\n\n- Latest Chrome/Safari/FF ESR\n- IE/Edge support is bast-effort basis\n - Some components may not be supported\n\nTo support IE, you need a couple additional setups:\n\n- Toolstack to re-transpile our code to ES5 (e.g. by specifying IE11 in\n [`@babel/preset-env`](https://babeljs.io/docs/en/babel-preset-env)\n configuration)\n- Polyfills, listed\n [here](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/main/packages/carbon-web-components/src/polyfills/index.ts)\n\nHere's an example code that shows such setup:\n\n[](https://codesandbox.io/s/github/carbon-design-system/carbon-for-ibm-dotcom/tree/main/packages/carbon-web-components/examples/codesandbox/ie)\n\n## Coding conventions\n\nCan be found at [here](./src/coding-conventions.md).\n\n## Creating build\n\n```\n> yarn clean\n> yarn build\n```\n\nYou'll see the build artifacts in `/path/to/carbon-web-components/es` directory.\n","readmeFilename":"README.md"}![\"Carbon](\"https://user-images.githubusercontent.com/3901764/57545698-ce5f2380-7320-11e9-8682-903df232d7b0.png\")
\n \n![\"Carbon](\"https://img.shields.io/badge/license-Apache--2.0-blue.svg\"){kind=icon}
\n \n![\"This](\"https://percy.io/static/images/percy-badge.svg\"){kind=icon}
\n \n