From a017a2840dc74fa6122a4a119cb6cfe9abb9f2e9 Mon Sep 17 00:00:00 2001 From: DitwanP Date: Thu, 23 Jan 2025 12:21:37 -0800 Subject: [PATCH 1/8] Removing stencil references - first pass --- CONTRIBUTING.md | 12 ++++++------ examples/components/react/README.md | 2 +- examples/components/webpack/README.md | 2 ++ packages/calcite-components-react/README.md | 6 ++++++ packages/calcite-components/FAQ.md | 2 +- .../conventions/Documentation.md | 10 +++------- .../conventions/Internationalization.md | 6 ++++-- .../calcite-components/conventions/README.md | 8 ++++++++ .../calcite-components/conventions/Styling.md | 2 ++ .../calcite-components/conventions/Testing.md | 2 ++ packages/calcite-components/readme.md | 16 ++++++---------- .../src/components/accordion/readme.md | 2 ++ .../eslint-plugin-calcite-components/README.md | 2 ++ .../docs/no-dynamic-createelement.md | 2 ++ .../docs/strict-boolean-attributes.md | 2 ++ 15 files changed, 49 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fce02bcb7bf..4d7b78832b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ You can help most by: - Adding ideas for components by [creating a New Component issue](https://github.com/Esri/calcite-design-system/issues/new?assignees=&labels=new+component%2C0+-+new%2Cneeds+triage&template=new-component.yml). - Working on [the issues marked as `help wanted`](https://github.com/Esri/calcite-design-system/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+no%3Aassignee). There is also a [`good first issue`](https://github.com/Esri/calcite-design-system/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+no%3Aassignee+) label if you are just getting started. - To let us know of your interest in the issue, please comment on the issue and ask for the action items before you start working. Sometimes additional context is needed, which may not be specified in the issue. Comments also provide us access to assign the issue to you. -- If you want to help develop components take a look at the [new component issues](https://github.com/Esri/calcite-design-system/issues?q=is%3Aopen+is%3Aissue+label%3A%22new+component%22). Before starting development please review our [component conventions](./conventions/README.md) and the [Stencil documentation](https://stenciljs.com/docs/introduction). +- If you want to help develop components take a look at the [new component issues](https://github.com/Esri/calcite-design-system/issues?q=is%3Aopen+is%3Aissue+label%3A%22new+component%22). Before starting development please review our [component conventions](./conventions/README.md) and the [Lit documentation](https://lit.dev/docs/getting-started/). If you aren't familiar with the basics of Web Components and Shadow DOM, please read through some of the following resources before contributing: @@ -61,7 +61,7 @@ There are four labels that mean an issue is not ready for development: - `design`: Issues that need design consultation, such as interaction research/feedback, visual mockups, and general approval. Once design completes their review, an additional label, `ready for dev` will be added to the issue, which means a developer can pick up the issue. - `spike`: Issues that need to research a question or resolve a complex task with uncertain outcomes. Once the spike has been performed a `spike complete` label is added to the issue, which means a developer can pick up the issue. - `need more info`: Issues that are missing information and/or a clear, actionable description. This can mean we are waiting on a user to provide additional context, we can't reproduce the issue, or further discussion is needed in order to determine a solution. -- `blocked`: Issues that cannot be worked on until a different issue is resolved. The blocking issue may be from an external library (Stencil, Storybook, Jest, etc.) or a Calcite Components issue. In the body or comments of a blocked issue, include a link to the blocking issue. To track when an issue is unblocked, add a comment in the blocking issue's body referencing the blocked issue(s). Use the following format for the comment: "Blocked issues: #0000, #0000". List multiple blocked issues by separating them with commas. +- `blocked`: Issues that cannot be worked on until a different issue is resolved. The blocking issue may be from an external library (Lit, Storybook, Jest, etc.) or a Calcite Components issue. In the body or comments of a blocked issue, include a link to the blocking issue. To track when an issue is unblocked, add a comment in the blocking issue's body referencing the blocked issue(s). Use the following format for the comment: "Blocked issues: #0000, #0000". List multiple blocked issues by separating them with commas. ### Milestones @@ -129,7 +129,7 @@ cd calcite-design-system npm install ``` -Next, start the local Stencil development server on localhost: +Next, start the local Vite development server on localhost: ```sh npm run start:components @@ -164,11 +164,11 @@ npm test `npm test` will run the test suites. -Calcite Components include Stencil's default testing tools which are built on [Jest](https://jestjs.io/) and [Puppeteer](https://github.com/GoogleChrome/puppeteer). +Calcite Components include Vitest testing tools which are powered by [Vite](https://vite.dev/) and [Puppeteer](https://github.com/GoogleChrome/puppeteer). If you're working on writing tests for a particular component, it can be helpful to use `npm --workspace=packages/calcite-components run test:watch` to retest on file changes. Once the initial tests run, typing `o` at the prompt will run tests only on changed files, allowing you to quickly iterate on tests for a specific component. You can also add a pattern to the end of the command to match for a test's file path. -Please refer to the [Stencil testing documentation](https://stenciljs.com/docs/testing-overview) and Calcite's [testing conventions](./conventions/Testing.md) for more information. +Please refer to Calcite's [testing conventions](./conventions/Testing.md) for more information. ## Adding a new component @@ -176,7 +176,7 @@ Before adding a new component, please read through the [component conventions gu ## Documenting a component -Stencil creates API reference documentation using JSDoc, here is their [documentation page](https://stenciljs.com/docs/docs-json). Calcite Components utilizes [Storybook](https://storybook.js.org/) for documenting components. Adding a new component is very simple: +Calcite Components utilizes [JSDoc](https://jsdoc.app/about-getting-started) to create API reference documentation and [Storybook](https://storybook.js.org/) for documenting components. Adding a new component is very simple: 1. Create a new file inside your component directory like `X.stories.js` 2. Write stories diff --git a/examples/components/react/README.md b/examples/components/react/README.md index 07689cb5cfb..caae85c350e 100644 --- a/examples/components/react/README.md +++ b/examples/components/react/README.md @@ -23,7 +23,7 @@ This package includes the compatible version of the main component library as a ### Setup components -[Custom Elements](https://stenciljs.com/docs/custom-elements) is the recommended build when using frontend frameworks, such as React. First, import and call `setAssetPath`, which ensures translations, icons, and other required assets are available to Calcite components (more on copying assets below). You can either use local assets, which will be explained in a subsequent step, or assets hosted on a CDN. This example uses local assets. +By default, Calcite components use assets hosted on a CDN. If you are hosting assets locally, you can import and use `setAssetPath`. This ensures that translations, icons, and other required assets are available to Calcite components. (More on copying assets below.) ```ts import { setAssetPath } from "@esri/calcite-components/dist/components"; diff --git a/examples/components/webpack/README.md b/examples/components/webpack/README.md index 9e0050cd0f7..1fb0f22c3ec 100644 --- a/examples/components/webpack/README.md +++ b/examples/components/webpack/README.md @@ -47,6 +47,8 @@ import "@esri/calcite-components/dist/calcite/calcite.css"; ### Configure Webpack + + Calcite components need to be copied to your output directory so Stencil can load them from the client. The easiest way to do this is with [copy-webpack-plugin](https://webpack.js.org/plugins/copy-webpack-plugin/). First, install the package: ```sh diff --git a/packages/calcite-components-react/README.md b/packages/calcite-components-react/README.md index 10579da7263..ce6d6821cc3 100644 --- a/packages/calcite-components-react/README.md +++ b/packages/calcite-components-react/README.md @@ -16,6 +16,8 @@ There are two builds that are provided by the standard `calcite-components` pack ### Custom Elements build + + [Custom Elements](https://stenciljs.com/docs/custom-elements) is the recommended build when using frontend frameworks, such as React. To use this build, you will need to set the path to the `calcite-components` assets. You can either use local assets, which will be explained in a subsequent step, or assets hosted on a CDN. ```jsx @@ -38,6 +40,8 @@ import { CalciteButton, CalciteIcon, CalciteSlider } from "@esri/calcite-compone ### Dist build + + When using the [Dist](https://stenciljs.com/docs/distribution) build, you'll need to manually define the custom elements on the window. You can also choose between local and CDN hosted assets. ```jsx @@ -85,6 +89,8 @@ function onUpdate(event) { setSliderValue(event.target.value); } +// TODO: Get suggestions for what this should be replaced with + // need to access the dom node to set custom event listeners for props that aren't strings / numbers // https://stenciljs.com/docs/react#properties-and-events useEffect( diff --git a/packages/calcite-components/FAQ.md b/packages/calcite-components/FAQ.md index 9161f4cd74a..33e23c515d6 100644 --- a/packages/calcite-components/FAQ.md +++ b/packages/calcite-components/FAQ.md @@ -30,7 +30,7 @@ Esri's design principles, components, and patterns can be consumed through a sui ## What are Calcite Components? -Calcite Components are a set of reusable web components built using Stencil.js. With Calcite Components, you can quickly build on-brand, lightweight, and accessible web applications. +Calcite Components are a set of reusable web components built using Lit. With Calcite Components, you can quickly build on-brand, lightweight, and accessible web applications. The framework-agnostic components can be used to develop entire websites and applications. The set is flexible for developers and adheres to consistent, industry-standard design principles. The codebase is well supported, steadily maintained, and always being improved. diff --git a/packages/calcite-components/conventions/Documentation.md b/packages/calcite-components/conventions/Documentation.md index dd4108095ac..9110fe6328d 100644 --- a/packages/calcite-components/conventions/Documentation.md +++ b/packages/calcite-components/conventions/Documentation.md @@ -1,10 +1,6 @@ # Documentation -## Stencil API reference - -Stencil uses [JSDoc](https://jsdoc.app) for their API reference generation. Stencil generates a [`docs-json`](https://stenciljs.com/docs/docs-json) output target, which is parsed and displayed on the [SDK site](https://developers.arcgis.com/calcite-design-system/components). The API reference includes property/attribute names, descriptions, types, values, and description notes (e.g. required, optional, deprecated). The SDK site updates the API reference after Calcite Component releases. - -### Style guide +## Style guide Follow these conventions when adding or editing API reference: @@ -15,7 +11,7 @@ Follow these conventions when adding or editing API reference: - For plural context, use `calcite-button`s instead of `calcite-button` elements. - Use backticks (`` ` ``) for the names of slots, events, properties, CSS variables, and component names (e.g. `calcite-button` instead of calcite-button and `selectionMode` instead of "selectionMode"). Also use backticks for the values of properties and event details (e.g. `true`). If the value is a string, use both backticks and double quotes (e.g. `"single-persist"`). - Only use single quotes (`'`) as apostrophes. -- No links or URLs allowed in descriptions. If a link is necessary, a [custom JSDoc tag](https://stenciljs.com/docs/docs-json#custom-jsdocs-tags) should be added and parsed in the SDK site. +- No links or URLs allowed in descriptions. If a link is necessary, a [custom JSDoc tag](https://stenciljs.com/docs/docs-json#custom-jsdocs-tags) should be added and parsed in the SDK site. - Refrain from using "e.g." or "i.e." references. Leverage "such as" (or similar) where examples are referenced. - Use "Accessible" instead of "Aria" or "a11y" language. - Verify slots and properties/attributes don't use the text "optional" in their descriptions. @@ -29,7 +25,7 @@ There are two ways to document deprecations, depending on the API reference. In ### Usage snippets -You can provide code snippets demonstrating a specific behavior or pattern for a component. Within the component's directory, create a new `usage` directory. Then, create a Markdown file with the filename as the title of the snippet. There should only be one snippet per Markdown file. Stencil will add the usage snippets to the component's README after building. These usage snippets will then be displayed in Storybook. +You can provide code snippets demonstrating a specific behavior or pattern for a component. Within the component's directory, create a new `usage` directory. Then, create a Markdown file with the filename as the title of the snippet. There should only be one snippet per Markdown file. The usage snippets will be added to the component's README after building. These usage snippets will then be displayed in Storybook. ### Using utilities diff --git a/packages/calcite-components/conventions/Internationalization.md b/packages/calcite-components/conventions/Internationalization.md index b4ef76ce55d..77809a4ba7b 100644 --- a/packages/calcite-components/conventions/Internationalization.md +++ b/packages/calcite-components/conventions/Internationalization.md @@ -66,8 +66,10 @@ This pattern enables components to support built-in translations. In order to su In the future it will likely become necessary to provide string translations for components. An example would be the `aria-label` for the `` close button. Initial research looks promising and we could likely implement one of these approaches and set a `lang` for each component. -- and -- + + +- ~~ and ~~ +- ~~~~ Until we implement a `lang` facility and set up translations for all components, we have been allowing a small number of strings to be passed in as properties. Properties that represent translated strings should have the syntax: `text-label-x`, where `x` is the name for the string. For example, when providing a string from "Close", use the property name `text-label-close`. In the component, these properties should default to their English equivalent (this is useful for non-localized apps): diff --git a/packages/calcite-components/conventions/README.md b/packages/calcite-components/conventions/README.md index 04afc996982..9e67ed2e708 100644 --- a/packages/calcite-components/conventions/README.md +++ b/packages/calcite-components/conventions/README.md @@ -303,6 +303,8 @@ my-component/ ... ``` + + The component's metadata should then include the following metadata prop [`assetsDirs: ["assets"]`](https://stenciljs.com/docs/assets#assetsdirs). ```tsx @@ -328,6 +330,8 @@ This is required in order to have a unified assets folder in the distributable. ## Bundling and Loading + + Stencil has the capability to build and distribute a large variety of outputs based on our needs. You can read more about this in the [output targets](https://github.com/ionic-team/stencil/blob/cc55401555ff5c28757cf99edf372dcada2c0b25/src/compiler/output-targets/readme.md) documentation. As a best practice we should follow [Ionic's configuration](https://github.com/ionic-team/ionic/blob/master/core/stencil.config.ts) and generate a `bundle` for each component. Stencil will then generate a loader that will dynamically load the components used on the page. @@ -366,6 +370,8 @@ This will create a unique id attribute like `id="calcite-example-51af-0941-54ae- ## Prerendering and SSR + + Stencil provide the capability to render web components on the server and seamlessly hydrate them on the client. This is handled by the `dist-hydrate-script` output target in `stencil.config.ts`. This generates a `hydrate` directory which exposes `renderToString()` (for the server) and `hydrateDocument()` for the client. @@ -419,6 +425,8 @@ There are utilities for common workflows in [`src/utils`](../src/utils). ### Global attributes + + Watching global attributes on components is now possible with Stencil v4. Please refer to the [documentation page](https://stenciljs.com/docs/reactive-data#watching-native-html-attributes) for more information. ### BigDecimal diff --git a/packages/calcite-components/conventions/Styling.md b/packages/calcite-components/conventions/Styling.md index ec5b51d3d6d..5c157827e8a 100644 --- a/packages/calcite-components/conventions/Styling.md +++ b/packages/calcite-components/conventions/Styling.md @@ -1,5 +1,7 @@ # Styling + + Be sure to set `shadow: true` in Stencil's `@Component` options to make sure styles are encapsulated in our Calcite design system. This helps keep our components consistent across applications. ## Avoid complex CSS selectors diff --git a/packages/calcite-components/conventions/Testing.md b/packages/calcite-components/conventions/Testing.md index 9d9b398a4ee..9ab14d44ec6 100644 --- a/packages/calcite-components/conventions/Testing.md +++ b/packages/calcite-components/conventions/Testing.md @@ -4,6 +4,8 @@ Components should have an automated test for any incoming features or bug fixes. We encourage writing expressive test cases and code that indicates intent. Use comments sparingly when the aforementioned can't be fully achieved. Keep it clean! + + Please see Stencil's doc for more info on [end-to-end](https://stenciljs.com/docs/end-to-end-testing) testing. See one of our test examples [here](https://github.com/Esri/calcite-design-system/blob/dev/packages/calcite-components/src/components/block/block.e2e.ts). ## Choosing which tests to write diff --git a/packages/calcite-components/readme.md b/packages/calcite-components/readme.md index 4a33b995a71..c3f97aeddab 100644 --- a/packages/calcite-components/readme.md +++ b/packages/calcite-components/readme.md @@ -1,4 +1,4 @@ -[![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)](https://stenciljs.com/) +[![Built With Lit](https://img.shields.io/badge/Built%20Wit%20Lit-black?style=flat-square&logo=lit&link=https%3A%2F%2Flit.dev%2F)](https://lit.dev/) [![npm package](https://img.shields.io/npm/v/@esri/calcite-components?style=flat-square&color=007AC2)](https://www.npmjs.com/package/@esri/calcite-components) [![minified size](https://img.shields.io/bundlephobia/min/@esri/calcite-components?style=flat-square&color=D83020)](https://bundlephobia.com/package/@esri/calcite-components) [![downloads per month](https://img.shields.io/npm/dm/@esri/calcite-components?style=flat-square&color=35AC46)](https://www.npmjs.com/package/@esri/calcite-components) @@ -44,6 +44,8 @@ Choose one of the two builds provided by Calcite Components. #### Custom Elements + + [Custom Elements](https://stenciljs.com/docs/custom-elements) is the recommended build when leveraging a frontend framework. To use this build, you will need to set the path to Calcite Components' assets. You can either use local assets, which will be explained in a subsequent step, or assets hosted on the CDN. ```jsx @@ -65,6 +67,8 @@ import "@esri/calcite-components/dist/components/calcite-slider"; #### Distribution + + When using the [Distribution](https://stenciljs.com/docs/distribution) build, you'll need to define the custom elements on the window. You can also choose between local and CDN hosted assets. ```jsx @@ -102,7 +106,7 @@ import "@esri/calcite-components/dist/calcite/calcite.css"; ## TypeScript -Stencil provides a full set of typings for all the components in this repo. To make TypeScript aware of these components, just import the library: +Lit provides a full set of typings for all the components in this repo. To make TypeScript aware of these components, just import the library: ```ts import "@esri/calcite-components"; @@ -122,14 +126,6 @@ const loader = document.querySelector(".my-loader-element") as HTMLCalciteLoader loader.active = true; ``` -## `@stencil/core` Version - -When using Stencil, make sure the `@stencil/core` version in your project matches the one used by Calcite Components. You may run into type errors if the `@stencil/core` versions are different. You can install the same Stencil version used by `@esri/calcite-components`: - -```bash -npm install @stencil/core@$(npm view @esri/calcite-components dependencies["@stencil/core"]) -``` - ## Browser Support diff --git a/packages/calcite-components/src/components/accordion/readme.md b/packages/calcite-components/src/components/accordion/readme.md index d8086691d14..e9377fc627d 100644 --- a/packages/calcite-components/src/components/accordion/readme.md +++ b/packages/calcite-components/src/components/accordion/readme.md @@ -29,4 +29,6 @@ For comprehensive guidance on using and implementing `calcite-accordion`, refer --- + + *Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/eslint-plugin-calcite-components/README.md b/packages/eslint-plugin-calcite-components/README.md index 3d515c79e07..5b323a0a549 100644 --- a/packages/eslint-plugin-calcite-components/README.md +++ b/packages/eslint-plugin-calcite-components/README.md @@ -1,5 +1,7 @@ # @esri/eslint-plugin-calcite-components + + ESLint rules specific to Stencil JS projects. ## Installation diff --git a/packages/eslint-plugin-calcite-components/docs/no-dynamic-createelement.md b/packages/eslint-plugin-calcite-components/docs/no-dynamic-createelement.md index 0da5b24a62d..56d26037e91 100644 --- a/packages/eslint-plugin-calcite-components/docs/no-dynamic-createelement.md +++ b/packages/eslint-plugin-calcite-components/docs/no-dynamic-createelement.md @@ -1,5 +1,7 @@ # no-dynamic-createelement + + Helps prevent usage of dynamic element tags used with `createElement`. This ensures the component is properly bundled and auto-defined in Stencil's `components` output target. ## Config diff --git a/packages/eslint-plugin-calcite-components/docs/strict-boolean-attributes.md b/packages/eslint-plugin-calcite-components/docs/strict-boolean-attributes.md index be5add04029..fc788efb795 100644 --- a/packages/eslint-plugin-calcite-components/docs/strict-boolean-attributes.md +++ b/packages/eslint-plugin-calcite-components/docs/strict-boolean-attributes.md @@ -1,5 +1,7 @@ # strict-boolean-attributes + + This rule will catch any Stencil Props that would produce boolean attributes that are not [HTML5-compliant](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#boolean-attributes). ## Config From 1c57792554cfded87bea7355192643a027ea76d4 Mon Sep 17 00:00:00 2001 From: DitwanP Date: Thu, 23 Jan 2025 12:28:22 -0800 Subject: [PATCH 2/8] typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d7b78832b4..425eb6ac418 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -164,7 +164,7 @@ npm test `npm test` will run the test suites. -Calcite Components include Vitest testing tools which are powered by [Vite](https://vite.dev/) and [Puppeteer](https://github.com/GoogleChrome/puppeteer). +Calcite Components include Vitest's testing tools which are powered by [Vite](https://vite.dev/) and [Puppeteer](https://github.com/GoogleChrome/puppeteer). If you're working on writing tests for a particular component, it can be helpful to use `npm --workspace=packages/calcite-components run test:watch` to retest on file changes. Once the initial tests run, typing `o` at the prompt will run tests only on changed files, allowing you to quickly iterate on tests for a specific component. You can also add a pattern to the end of the command to match for a test's file path. From bfb5706d08bf7242f4b36210036c28d924169e39 Mon Sep 17 00:00:00 2001 From: Ditwan Price Date: Wed, 29 Jan 2025 00:42:29 +0100 Subject: [PATCH 3/8] Feedback change Co-authored-by: Ben Elan --- examples/components/webpack/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/examples/components/webpack/README.md b/examples/components/webpack/README.md index 1fb0f22c3ec..37e1efb00ea 100644 --- a/examples/components/webpack/README.md +++ b/examples/components/webpack/README.md @@ -47,9 +47,7 @@ import "@esri/calcite-components/dist/calcite/calcite.css"; ### Configure Webpack - - -Calcite components need to be copied to your output directory so Stencil can load them from the client. The easiest way to do this is with [copy-webpack-plugin](https://webpack.js.org/plugins/copy-webpack-plugin/). First, install the package: +Calcite components need to be copied to your output directory so they can be loaded from the client. The easiest way to do this is with [copy-webpack-plugin](https://webpack.js.org/plugins/copy-webpack-plugin/). First, install the package: ```sh npm install -D copy-webpack-plugin From b23b710f146a08f8207680869643c94b833de594 Mon Sep 17 00:00:00 2001 From: Ditwan Price Date: Wed, 29 Jan 2025 00:43:33 +0100 Subject: [PATCH 4/8] Feedback change Co-authored-by: Ben Elan --- packages/calcite-components/conventions/Documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/calcite-components/conventions/Documentation.md b/packages/calcite-components/conventions/Documentation.md index 9110fe6328d..aaa6c6c3d08 100644 --- a/packages/calcite-components/conventions/Documentation.md +++ b/packages/calcite-components/conventions/Documentation.md @@ -11,7 +11,7 @@ Follow these conventions when adding or editing API reference: - For plural context, use `calcite-button`s instead of `calcite-button` elements. - Use backticks (`` ` ``) for the names of slots, events, properties, CSS variables, and component names (e.g. `calcite-button` instead of calcite-button and `selectionMode` instead of "selectionMode"). Also use backticks for the values of properties and event details (e.g. `true`). If the value is a string, use both backticks and double quotes (e.g. `"single-persist"`). - Only use single quotes (`'`) as apostrophes. -- No links or URLs allowed in descriptions. If a link is necessary, a [custom JSDoc tag](https://stenciljs.com/docs/docs-json#custom-jsdocs-tags) should be added and parsed in the SDK site. +- No links or URLs allowed in descriptions. If a link is necessary, a custom JSDoc tag should be added and parsed in the SDK site. - Refrain from using "e.g." or "i.e." references. Leverage "such as" (or similar) where examples are referenced. - Use "Accessible" instead of "Aria" or "a11y" language. - Verify slots and properties/attributes don't use the text "optional" in their descriptions. From 322f2b49a97f78a7794bac8abe7a9e9883ec8794 Mon Sep 17 00:00:00 2001 From: DitwanP Date: Tue, 28 Jan 2025 16:12:22 -0800 Subject: [PATCH 5/8] Remove stencil links from readme files --- .../src/components/accordion-item/readme.md | 2 -- .../calcite-components/src/components/accordion/readme.md | 4 ---- .../calcite-components/src/components/action-bar/readme.md | 2 -- .../calcite-components/src/components/action-group/readme.md | 2 -- .../calcite-components/src/components/action-menu/readme.md | 2 -- .../calcite-components/src/components/action-pad/readme.md | 2 -- packages/calcite-components/src/components/action/readme.md | 2 -- packages/calcite-components/src/components/alert/readme.md | 2 -- packages/calcite-components/src/components/avatar/readme.md | 2 -- .../calcite-components/src/components/block-section/readme.md | 2 -- packages/calcite-components/src/components/block/readme.md | 2 -- packages/calcite-components/src/components/button/readme.md | 2 -- .../calcite-components/src/components/card-group/readme.md | 2 -- packages/calcite-components/src/components/card/readme.md | 2 -- .../calcite-components/src/components/carousel-item/readme.md | 2 -- packages/calcite-components/src/components/carousel/readme.md | 2 -- packages/calcite-components/src/components/checkbox/readme.md | 2 -- .../calcite-components/src/components/chip-group/readme.md | 2 -- packages/calcite-components/src/components/chip/readme.md | 2 -- .../src/components/color-picker-hex-input/readme.md | 2 -- .../src/components/color-picker-swatch/readme.md | 2 -- .../calcite-components/src/components/color-picker/readme.md | 2 -- .../src/components/combobox-item-group/readme.md | 2 -- .../calcite-components/src/components/combobox-item/readme.md | 2 -- packages/calcite-components/src/components/combobox/readme.md | 2 -- .../src/components/date-picker-day/readme.md | 2 -- .../src/components/date-picker-month-header/readme.md | 2 -- .../src/components/date-picker-month/readme.md | 2 -- .../calcite-components/src/components/date-picker/readme.md | 2 -- packages/calcite-components/src/components/dialog/readme.md | 2 -- .../src/components/dropdown-group/readme.md | 2 -- .../calcite-components/src/components/dropdown-item/readme.md | 2 -- packages/calcite-components/src/components/dropdown/readme.md | 2 -- packages/calcite-components/src/components/fab/readme.md | 2 -- packages/calcite-components/src/components/filter/readme.md | 2 -- .../calcite-components/src/components/flow-item/readme.md | 2 -- packages/calcite-components/src/components/flow/readme.md | 2 -- packages/calcite-components/src/components/graph/readme.md | 2 -- packages/calcite-components/src/components/handle/readme.md | 2 -- packages/calcite-components/src/components/icon/readme.md | 2 -- .../src/components/inline-editable/readme.md | 2 -- .../src/components/input-date-picker/readme.md | 2 -- .../calcite-components/src/components/input-message/readme.md | 2 -- .../calcite-components/src/components/input-number/readme.md | 2 -- .../calcite-components/src/components/input-text/readme.md | 2 -- .../src/components/input-time-picker/readme.md | 2 -- .../src/components/input-time-zone/readme.md | 2 -- packages/calcite-components/src/components/input/readme.md | 2 -- packages/calcite-components/src/components/label/readme.md | 2 -- packages/calcite-components/src/components/link/readme.md | 2 -- .../src/components/list-item-group/readme.md | 2 -- .../calcite-components/src/components/list-item/readme.md | 2 -- packages/calcite-components/src/components/list/readme.md | 2 -- packages/calcite-components/src/components/loader/readme.md | 2 -- .../calcite-components/src/components/menu-item/readme.md | 2 -- packages/calcite-components/src/components/menu/readme.md | 2 -- packages/calcite-components/src/components/meter/readme.md | 2 -- packages/calcite-components/src/components/modal/readme.md | 2 -- .../src/components/navigation-logo/readme.md | 2 -- .../src/components/navigation-user/readme.md | 2 -- .../calcite-components/src/components/navigation/readme.md | 2 -- packages/calcite-components/src/components/notice/readme.md | 2 -- .../calcite-components/src/components/option-group/readme.md | 2 -- packages/calcite-components/src/components/option/readme.md | 2 -- .../calcite-components/src/components/pagination/readme.md | 2 -- packages/calcite-components/src/components/panel/readme.md | 2 -- packages/calcite-components/src/components/popover/readme.md | 2 -- packages/calcite-components/src/components/progress/readme.md | 2 -- .../src/components/radio-button-group/readme.md | 2 -- .../calcite-components/src/components/radio-button/readme.md | 2 -- packages/calcite-components/src/components/rating/readme.md | 2 -- packages/calcite-components/src/components/scrim/readme.md | 2 -- .../src/components/segmented-control-item/readme.md | 2 -- .../src/components/segmented-control/readme.md | 2 -- packages/calcite-components/src/components/select/readme.md | 2 -- packages/calcite-components/src/components/sheet/readme.md | 2 -- .../src/components/shell-center-row/readme.md | 2 -- .../calcite-components/src/components/shell-panel/readme.md | 2 -- packages/calcite-components/src/components/shell/readme.md | 2 -- packages/calcite-components/src/components/slider/readme.md | 2 -- .../calcite-components/src/components/sortable-list/readme.md | 2 -- .../calcite-components/src/components/split-button/readme.md | 2 -- packages/calcite-components/src/components/stack/readme.md | 2 -- .../calcite-components/src/components/stepper-item/readme.md | 2 -- packages/calcite-components/src/components/stepper/readme.md | 2 -- packages/calcite-components/src/components/switch/readme.md | 2 -- packages/calcite-components/src/components/tab-nav/readme.md | 2 -- .../calcite-components/src/components/tab-title/readme.md | 2 -- packages/calcite-components/src/components/tab/readme.md | 2 -- .../calcite-components/src/components/table-cell/readme.md | 2 -- .../calcite-components/src/components/table-header/readme.md | 2 -- .../calcite-components/src/components/table-row/readme.md | 2 -- packages/calcite-components/src/components/table/readme.md | 2 -- packages/calcite-components/src/components/tabs/readme.md | 2 -- .../calcite-components/src/components/text-area/readme.md | 2 -- .../calcite-components/src/components/tile-group/readme.md | 2 -- .../src/components/tile-select-group/readme.md | 2 -- .../calcite-components/src/components/tile-select/readme.md | 2 -- packages/calcite-components/src/components/tile/readme.md | 2 -- .../calcite-components/src/components/time-picker/readme.md | 2 -- .../calcite-components/src/components/tip-group/readme.md | 2 -- .../calcite-components/src/components/tip-manager/readme.md | 2 -- packages/calcite-components/src/components/tip/readme.md | 2 -- packages/calcite-components/src/components/tooltip/readme.md | 2 -- .../calcite-components/src/components/tree-item/readme.md | 2 -- packages/calcite-components/src/components/tree/readme.md | 2 -- 106 files changed, 214 deletions(-) diff --git a/packages/calcite-components/src/components/accordion-item/readme.md b/packages/calcite-components/src/components/accordion-item/readme.md index 672707f2083..1612f18f97e 100644 --- a/packages/calcite-components/src/components/accordion-item/readme.md +++ b/packages/calcite-components/src/components/accordion-item/readme.md @@ -67,5 +67,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/accordion/readme.md b/packages/calcite-components/src/components/accordion/readme.md index e9377fc627d..81ae9954eff 100644 --- a/packages/calcite-components/src/components/accordion/readme.md +++ b/packages/calcite-components/src/components/accordion/readme.md @@ -28,7 +28,3 @@ For comprehensive guidance on using and implementing `calcite-accordion`, refer | `--calcite-accordion-border-color` | Specifies the component's border color. | --- - - - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/action-bar/readme.md b/packages/calcite-components/src/components/action-bar/readme.md index fa0c0629077..e1db4ac6889 100755 --- a/packages/calcite-components/src/components/action-bar/readme.md +++ b/packages/calcite-components/src/components/action-bar/readme.md @@ -77,5 +77,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/action-group/readme.md b/packages/calcite-components/src/components/action-group/readme.md index a01486e00b2..92923b07498 100755 --- a/packages/calcite-components/src/components/action-group/readme.md +++ b/packages/calcite-components/src/components/action-group/readme.md @@ -77,5 +77,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/action-menu/readme.md b/packages/calcite-components/src/components/action-menu/readme.md index 5efb092bc38..aa0ec03afd8 100644 --- a/packages/calcite-components/src/components/action-menu/readme.md +++ b/packages/calcite-components/src/components/action-menu/readme.md @@ -75,5 +75,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/action-pad/readme.md b/packages/calcite-components/src/components/action-pad/readme.md index cb11adc04e4..f0417c6a101 100755 --- a/packages/calcite-components/src/components/action-pad/readme.md +++ b/packages/calcite-components/src/components/action-pad/readme.md @@ -73,5 +73,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/action/readme.md b/packages/calcite-components/src/components/action/readme.md index 68910df5b98..2af52d90a60 100755 --- a/packages/calcite-components/src/components/action/readme.md +++ b/packages/calcite-components/src/components/action/readme.md @@ -106,5 +106,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/alert/readme.md b/packages/calcite-components/src/components/alert/readme.md index 9bb5a642ac9..2d8283828b4 100644 --- a/packages/calcite-components/src/components/alert/readme.md +++ b/packages/calcite-components/src/components/alert/readme.md @@ -76,5 +76,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/avatar/readme.md b/packages/calcite-components/src/components/avatar/readme.md index 65ef1e23859..dd399fc3944 100644 --- a/packages/calcite-components/src/components/avatar/readme.md +++ b/packages/calcite-components/src/components/avatar/readme.md @@ -43,5 +43,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/block-section/readme.md b/packages/calcite-components/src/components/block-section/readme.md index 9df4f6b6195..1b16063b775 100644 --- a/packages/calcite-components/src/components/block-section/readme.md +++ b/packages/calcite-components/src/components/block-section/readme.md @@ -56,5 +56,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/block/readme.md b/packages/calcite-components/src/components/block/readme.md index be3bc1c5a2b..998935265dc 100644 --- a/packages/calcite-components/src/components/block/readme.md +++ b/packages/calcite-components/src/components/block/readme.md @@ -93,5 +93,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/button/readme.md b/packages/calcite-components/src/components/button/readme.md index 7b108183693..7952bbe8eff 100644 --- a/packages/calcite-components/src/components/button/readme.md +++ b/packages/calcite-components/src/components/button/readme.md @@ -78,5 +78,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/card-group/readme.md b/packages/calcite-components/src/components/card-group/readme.md index 24136b4f452..4095a9d8cc5 100644 --- a/packages/calcite-components/src/components/card-group/readme.md +++ b/packages/calcite-components/src/components/card-group/readme.md @@ -43,5 +43,3 @@ Type: `Promise` | `--calcite-card-group-space` | Specifies the space between slotted elements. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/card/readme.md b/packages/calcite-components/src/components/card/readme.md index 1ac70e1c9f1..f9ef5a185a6 100644 --- a/packages/calcite-components/src/components/card/readme.md +++ b/packages/calcite-components/src/components/card/readme.md @@ -86,5 +86,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/carousel-item/readme.md b/packages/calcite-components/src/components/carousel-item/readme.md index fb89c5ca819..4ef2f3afee9 100644 --- a/packages/calcite-components/src/components/carousel-item/readme.md +++ b/packages/calcite-components/src/components/carousel-item/readme.md @@ -16,5 +16,3 @@ | | A slot for adding content. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/carousel/readme.md b/packages/calcite-components/src/components/carousel/readme.md index 5bd1b831285..1327387e531 100644 --- a/packages/calcite-components/src/components/carousel/readme.md +++ b/packages/calcite-components/src/components/carousel/readme.md @@ -74,5 +74,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/checkbox/readme.md b/packages/calcite-components/src/components/checkbox/readme.md index c523b5a982f..18284e8e966 100644 --- a/packages/calcite-components/src/components/checkbox/readme.md +++ b/packages/calcite-components/src/components/checkbox/readme.md @@ -63,5 +63,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/chip-group/readme.md b/packages/calcite-components/src/components/chip-group/readme.md index 10a2c1277fe..1a24b17f430 100644 --- a/packages/calcite-components/src/components/chip-group/readme.md +++ b/packages/calcite-components/src/components/chip-group/readme.md @@ -37,5 +37,3 @@ Type: `Promise` | | A slot for adding one or more `calcite-chip`s. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/chip/readme.md b/packages/calcite-components/src/components/chip/readme.md index 813b942dd19..eafa1ae0758 100644 --- a/packages/calcite-components/src/components/chip/readme.md +++ b/packages/calcite-components/src/components/chip/readme.md @@ -84,5 +84,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/color-picker-hex-input/readme.md b/packages/calcite-components/src/components/color-picker-hex-input/readme.md index 11e082d6335..33ae298adb9 100644 --- a/packages/calcite-components/src/components/color-picker-hex-input/readme.md +++ b/packages/calcite-components/src/components/color-picker-hex-input/readme.md @@ -58,5 +58,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/color-picker-swatch/readme.md b/packages/calcite-components/src/components/color-picker-swatch/readme.md index 96f4a35378f..a55c5bc719c 100644 --- a/packages/calcite-components/src/components/color-picker-swatch/readme.md +++ b/packages/calcite-components/src/components/color-picker-swatch/readme.md @@ -25,5 +25,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/color-picker/readme.md b/packages/calcite-components/src/components/color-picker/readme.md index 96d27238188..c913bd161e6 100644 --- a/packages/calcite-components/src/components/color-picker/readme.md +++ b/packages/calcite-components/src/components/color-picker/readme.md @@ -84,5 +84,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/combobox-item-group/readme.md b/packages/calcite-components/src/components/combobox-item-group/readme.md index 8650ba88aac..5ff444dcd98 100644 --- a/packages/calcite-components/src/components/combobox-item-group/readme.md +++ b/packages/calcite-components/src/components/combobox-item-group/readme.md @@ -32,5 +32,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/combobox-item/readme.md b/packages/calcite-components/src/components/combobox-item/readme.md index 131cd12ee6b..2800dd4bc76 100644 --- a/packages/calcite-components/src/components/combobox-item/readme.md +++ b/packages/calcite-components/src/components/combobox-item/readme.md @@ -59,5 +59,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/combobox/readme.md b/packages/calcite-components/src/components/combobox/readme.md index 69d025c428c..9a12ffd983f 100644 --- a/packages/calcite-components/src/components/combobox/readme.md +++ b/packages/calcite-components/src/components/combobox/readme.md @@ -115,5 +115,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/date-picker-day/readme.md b/packages/calcite-components/src/components/date-picker-day/readme.md index 94c08bd32a3..ba57bb10625 100644 --- a/packages/calcite-components/src/components/date-picker-day/readme.md +++ b/packages/calcite-components/src/components/date-picker-day/readme.md @@ -50,5 +50,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/date-picker-month-header/readme.md b/packages/calcite-components/src/components/date-picker-month-header/readme.md index 13602062c39..90f85fc387a 100644 --- a/packages/calcite-components/src/components/date-picker-month-header/readme.md +++ b/packages/calcite-components/src/components/date-picker-month-header/readme.md @@ -44,5 +44,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/date-picker-month/readme.md b/packages/calcite-components/src/components/date-picker-month/readme.md index 9b042cff920..72a2028d19a 100644 --- a/packages/calcite-components/src/components/date-picker-month/readme.md +++ b/packages/calcite-components/src/components/date-picker-month/readme.md @@ -48,5 +48,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/date-picker/readme.md b/packages/calcite-components/src/components/date-picker/readme.md index 53836bf039c..3c6e38442af 100644 --- a/packages/calcite-components/src/components/date-picker/readme.md +++ b/packages/calcite-components/src/components/date-picker/readme.md @@ -72,5 +72,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/dialog/readme.md b/packages/calcite-components/src/components/dialog/readme.md index 45202a4fd86..c898ea0324f 100644 --- a/packages/calcite-components/src/components/dialog/readme.md +++ b/packages/calcite-components/src/components/dialog/readme.md @@ -143,5 +143,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/dropdown-group/readme.md b/packages/calcite-components/src/components/dropdown-group/readme.md index 7c138c2872f..bf4bd9d251f 100644 --- a/packages/calcite-components/src/components/dropdown-group/readme.md +++ b/packages/calcite-components/src/components/dropdown-group/readme.md @@ -18,5 +18,3 @@ For comprehensive guidance on using and implementing `calcite-dropdown-group`, r | | A slot for adding `calcite-dropdown-item`s. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/dropdown-item/readme.md b/packages/calcite-components/src/components/dropdown-item/readme.md index cc75f3d2d2b..936e87fe0d9 100644 --- a/packages/calcite-components/src/components/dropdown-item/readme.md +++ b/packages/calcite-components/src/components/dropdown-item/readme.md @@ -55,5 +55,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/dropdown/readme.md b/packages/calcite-components/src/components/dropdown/readme.md index a726aeb85a9..2595ec4e1c4 100644 --- a/packages/calcite-components/src/components/dropdown/readme.md +++ b/packages/calcite-components/src/components/dropdown/readme.md @@ -82,5 +82,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/fab/readme.md b/packages/calcite-components/src/components/fab/readme.md index cdd36a7833f..53a260129ad 100644 --- a/packages/calcite-components/src/components/fab/readme.md +++ b/packages/calcite-components/src/components/fab/readme.md @@ -46,5 +46,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/filter/readme.md b/packages/calcite-components/src/components/filter/readme.md index 0e1441ecaa1..7734f734a64 100644 --- a/packages/calcite-components/src/components/filter/readme.md +++ b/packages/calcite-components/src/components/filter/readme.md @@ -77,5 +77,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/flow-item/readme.md b/packages/calcite-components/src/components/flow-item/readme.md index dfa0004a958..e27b1f7b731 100644 --- a/packages/calcite-components/src/components/flow-item/readme.md +++ b/packages/calcite-components/src/components/flow-item/readme.md @@ -114,5 +114,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/flow/readme.md b/packages/calcite-components/src/components/flow/readme.md index d03746dac13..639ac2cd8e4 100644 --- a/packages/calcite-components/src/components/flow/readme.md +++ b/packages/calcite-components/src/components/flow/readme.md @@ -29,5 +29,3 @@ Type: `Promise` | | A slot for adding `calcite-flow-item` elements to the component. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/graph/readme.md b/packages/calcite-components/src/components/graph/readme.md index bbbfd730454..2a0f761109b 100644 --- a/packages/calcite-components/src/components/graph/readme.md +++ b/packages/calcite-components/src/components/graph/readme.md @@ -30,5 +30,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/handle/readme.md b/packages/calcite-components/src/components/handle/readme.md index 8a39aa46d0e..2b7317088c3 100644 --- a/packages/calcite-components/src/components/handle/readme.md +++ b/packages/calcite-components/src/components/handle/readme.md @@ -61,5 +61,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/icon/readme.md b/packages/calcite-components/src/components/icon/readme.md index 2f605dd9453..cbf8d63a1fd 100644 --- a/packages/calcite-components/src/components/icon/readme.md +++ b/packages/calcite-components/src/components/icon/readme.md @@ -117,5 +117,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/inline-editable/readme.md b/packages/calcite-components/src/components/inline-editable/readme.md index 35292011c2e..2f78d9b2081 100644 --- a/packages/calcite-components/src/components/inline-editable/readme.md +++ b/packages/calcite-components/src/components/inline-editable/readme.md @@ -56,5 +56,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/input-date-picker/readme.md b/packages/calcite-components/src/components/input-date-picker/readme.md index 6239a7084ba..f94ccfd62f4 100644 --- a/packages/calcite-components/src/components/input-date-picker/readme.md +++ b/packages/calcite-components/src/components/input-date-picker/readme.md @@ -108,5 +108,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/input-message/readme.md b/packages/calcite-components/src/components/input-message/readme.md index bc00c93485e..53fe8b974bc 100644 --- a/packages/calcite-components/src/components/input-message/readme.md +++ b/packages/calcite-components/src/components/input-message/readme.md @@ -63,5 +63,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/input-number/readme.md b/packages/calcite-components/src/components/input-number/readme.md index 3c4a6cabad5..cb336644fef 100644 --- a/packages/calcite-components/src/components/input-number/readme.md +++ b/packages/calcite-components/src/components/input-number/readme.md @@ -106,5 +106,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/input-text/readme.md b/packages/calcite-components/src/components/input-text/readme.md index abd33129b4d..824118c4025 100644 --- a/packages/calcite-components/src/components/input-text/readme.md +++ b/packages/calcite-components/src/components/input-text/readme.md @@ -102,5 +102,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/input-time-picker/readme.md b/packages/calcite-components/src/components/input-time-picker/readme.md index 500a31f27a3..43ef48a5ffc 100644 --- a/packages/calcite-components/src/components/input-time-picker/readme.md +++ b/packages/calcite-components/src/components/input-time-picker/readme.md @@ -95,5 +95,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/input-time-zone/readme.md b/packages/calcite-components/src/components/input-time-zone/readme.md index d5561bec07e..c4722b5b488 100644 --- a/packages/calcite-components/src/components/input-time-zone/readme.md +++ b/packages/calcite-components/src/components/input-time-zone/readme.md @@ -71,5 +71,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/input/readme.md b/packages/calcite-components/src/components/input/readme.md index 3794ab9bf68..0e95c86e30f 100644 --- a/packages/calcite-components/src/components/input/readme.md +++ b/packages/calcite-components/src/components/input/readme.md @@ -108,5 +108,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/label/readme.md b/packages/calcite-components/src/components/label/readme.md index 768b335dae0..2bab320c72e 100644 --- a/packages/calcite-components/src/components/label/readme.md +++ b/packages/calcite-components/src/components/label/readme.md @@ -40,5 +40,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/link/readme.md b/packages/calcite-components/src/components/link/readme.md index 899a5defa7c..e1f544885bf 100644 --- a/packages/calcite-components/src/components/link/readme.md +++ b/packages/calcite-components/src/components/link/readme.md @@ -53,5 +53,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/list-item-group/readme.md b/packages/calcite-components/src/components/list-item-group/readme.md index b9e8112e552..c49049d1b8a 100644 --- a/packages/calcite-components/src/components/list-item-group/readme.md +++ b/packages/calcite-components/src/components/list-item-group/readme.md @@ -24,5 +24,3 @@ For comprehensive guidance on using and implementing `calcite-list-item-group`, | | A slot for adding `calcite-list-item` and `calcite-list-item-group` elements. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/list-item/readme.md b/packages/calcite-components/src/components/list-item/readme.md index 9390fc01734..f2e80f3b20d 100644 --- a/packages/calcite-components/src/components/list-item/readme.md +++ b/packages/calcite-components/src/components/list-item/readme.md @@ -75,5 +75,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/list/readme.md b/packages/calcite-components/src/components/list/readme.md index 41a353ecffd..1f470688f40 100644 --- a/packages/calcite-components/src/components/list/readme.md +++ b/packages/calcite-components/src/components/list/readme.md @@ -87,5 +87,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/loader/readme.md b/packages/calcite-components/src/components/loader/readme.md index 86d8dca05ee..acf4d675fd4 100644 --- a/packages/calcite-components/src/components/loader/readme.md +++ b/packages/calcite-components/src/components/loader/readme.md @@ -47,5 +47,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/menu-item/readme.md b/packages/calcite-components/src/components/menu-item/readme.md index 681add56717..300167bf463 100644 --- a/packages/calcite-components/src/components/menu-item/readme.md +++ b/packages/calcite-components/src/components/menu-item/readme.md @@ -64,5 +64,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/menu/readme.md b/packages/calcite-components/src/components/menu/readme.md index bbb94d69dad..0808bd4e6fd 100644 --- a/packages/calcite-components/src/components/menu/readme.md +++ b/packages/calcite-components/src/components/menu/readme.md @@ -37,5 +37,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/meter/readme.md b/packages/calcite-components/src/components/meter/readme.md index 394a971563f..1f3d31f0de1 100644 --- a/packages/calcite-components/src/components/meter/readme.md +++ b/packages/calcite-components/src/components/meter/readme.md @@ -29,5 +29,3 @@ For comprehensive guidance on using and implementing `calcite-meter`, refer to t | `valueLabelType` | `value-label-type` | When `valueLabel` is `true`, specifies the format of displayed label. | `"percent" \| "units"` | `"percent"` | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/modal/readme.md b/packages/calcite-components/src/components/modal/readme.md index 70da78039c1..98f048bd5ea 100644 --- a/packages/calcite-components/src/components/modal/readme.md +++ b/packages/calcite-components/src/components/modal/readme.md @@ -110,5 +110,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/navigation-logo/readme.md b/packages/calcite-components/src/components/navigation-logo/readme.md index 4c9738fcd7d..a3126e73038 100644 --- a/packages/calcite-components/src/components/navigation-logo/readme.md +++ b/packages/calcite-components/src/components/navigation-logo/readme.md @@ -45,5 +45,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/navigation-user/readme.md b/packages/calcite-components/src/components/navigation-user/readme.md index fb89a8db15a..3b997ba530b 100644 --- a/packages/calcite-components/src/components/navigation-user/readme.md +++ b/packages/calcite-components/src/components/navigation-user/readme.md @@ -42,5 +42,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/navigation/readme.md b/packages/calcite-components/src/components/navigation/readme.md index 07da7c7cb5f..0aa36858f86 100644 --- a/packages/calcite-components/src/components/navigation/readme.md +++ b/packages/calcite-components/src/components/navigation/readme.md @@ -66,5 +66,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/notice/readme.md b/packages/calcite-components/src/components/notice/readme.md index e7d6fd2fc1e..720f0ca16d5 100644 --- a/packages/calcite-components/src/components/notice/readme.md +++ b/packages/calcite-components/src/components/notice/readme.md @@ -66,5 +66,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/option-group/readme.md b/packages/calcite-components/src/components/option-group/readme.md index 3ba79c11947..8814957b198 100644 --- a/packages/calcite-components/src/components/option-group/readme.md +++ b/packages/calcite-components/src/components/option-group/readme.md @@ -18,5 +18,3 @@ For comprehensive guidance on using and implementing `calcite-option-group`, ref | | A slot for adding `calcite-option`s. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/option/readme.md b/packages/calcite-components/src/components/option/readme.md index 62ab3393889..21d7e7e71dc 100644 --- a/packages/calcite-components/src/components/option/readme.md +++ b/packages/calcite-components/src/components/option/readme.md @@ -28,5 +28,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/pagination/readme.md b/packages/calcite-components/src/components/pagination/readme.md index e6e4943b712..383323153e4 100644 --- a/packages/calcite-components/src/components/pagination/readme.md +++ b/packages/calcite-components/src/components/pagination/readme.md @@ -82,5 +82,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/panel/readme.md b/packages/calcite-components/src/components/panel/readme.md index 1a3e736257a..53c0012db55 100644 --- a/packages/calcite-components/src/components/panel/readme.md +++ b/packages/calcite-components/src/components/panel/readme.md @@ -120,5 +120,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/popover/readme.md b/packages/calcite-components/src/components/popover/readme.md index c8f2f1a2074..391a62c9ebb 100644 --- a/packages/calcite-components/src/components/popover/readme.md +++ b/packages/calcite-components/src/components/popover/readme.md @@ -110,5 +110,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/progress/readme.md b/packages/calcite-components/src/components/progress/readme.md index de868c32f15..92bdc26b915 100644 --- a/packages/calcite-components/src/components/progress/readme.md +++ b/packages/calcite-components/src/components/progress/readme.md @@ -43,5 +43,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/radio-button-group/readme.md b/packages/calcite-components/src/components/radio-button-group/readme.md index 8e3b01e95bb..aeec42c180a 100644 --- a/packages/calcite-components/src/components/radio-button-group/readme.md +++ b/packages/calcite-components/src/components/radio-button-group/readme.md @@ -56,5 +56,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/radio-button/readme.md b/packages/calcite-components/src/components/radio-button/readme.md index f6dbcc8f4ea..3d2ee632aa7 100644 --- a/packages/calcite-components/src/components/radio-button/readme.md +++ b/packages/calcite-components/src/components/radio-button/readme.md @@ -48,5 +48,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/rating/readme.md b/packages/calcite-components/src/components/rating/readme.md index 50472fe6069..6988852c7d0 100644 --- a/packages/calcite-components/src/components/rating/readme.md +++ b/packages/calcite-components/src/components/rating/readme.md @@ -59,5 +59,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/scrim/readme.md b/packages/calcite-components/src/components/scrim/readme.md index d4c50a0fcb7..ed4983e9fd0 100644 --- a/packages/calcite-components/src/components/scrim/readme.md +++ b/packages/calcite-components/src/components/scrim/readme.md @@ -57,5 +57,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/segmented-control-item/readme.md b/packages/calcite-components/src/components/segmented-control-item/readme.md index 078bef219e8..6ceb2b65e81 100644 --- a/packages/calcite-components/src/components/segmented-control-item/readme.md +++ b/packages/calcite-components/src/components/segmented-control-item/readme.md @@ -29,5 +29,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/segmented-control/readme.md b/packages/calcite-components/src/components/segmented-control/readme.md index 3ddaa48cf20..173eef5fe73 100644 --- a/packages/calcite-components/src/components/segmented-control/readme.md +++ b/packages/calcite-components/src/components/segmented-control/readme.md @@ -61,5 +61,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/select/readme.md b/packages/calcite-components/src/components/select/readme.md index 13bace1ad17..ff0c26a7cd0 100644 --- a/packages/calcite-components/src/components/select/readme.md +++ b/packages/calcite-components/src/components/select/readme.md @@ -75,5 +75,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/sheet/readme.md b/packages/calcite-components/src/components/sheet/readme.md index 44f8c0276e0..2026e019050 100644 --- a/packages/calcite-components/src/components/sheet/readme.md +++ b/packages/calcite-components/src/components/sheet/readme.md @@ -74,5 +74,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/shell-center-row/readme.md b/packages/calcite-components/src/components/shell-center-row/readme.md index 63e66fe16c1..e6ee6e1bc64 100644 --- a/packages/calcite-components/src/components/shell-center-row/readme.md +++ b/packages/calcite-components/src/components/shell-center-row/readme.md @@ -22,5 +22,3 @@ For comprehensive guidance on using and implementing `calcite-shell-center-row`, | `"action-bar"` | A slot for adding a `calcite-action-bar` to the `calcite-shell-panel`. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/shell-panel/readme.md b/packages/calcite-components/src/components/shell-panel/readme.md index ff57e7c397c..3a3558c4bd3 100644 --- a/packages/calcite-components/src/components/shell-panel/readme.md +++ b/packages/calcite-components/src/components/shell-panel/readme.md @@ -40,5 +40,3 @@ For comprehensive guidance on using and implementing `calcite-shell-panel`, refe | `--calcite-shell-panel-z-index` | Specifies the z-index value for the component. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/shell/readme.md b/packages/calcite-components/src/components/shell/readme.md index 8502c8baa22..143f80a29fb 100644 --- a/packages/calcite-components/src/components/shell/readme.md +++ b/packages/calcite-components/src/components/shell/readme.md @@ -34,5 +34,3 @@ For comprehensive guidance on using and implementing `calcite-shell`, refer to t | `--calcite-shell-tip-spacing` | The left and right spacing of the `calcite-tip-manager` when slotted in the component. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/slider/readme.md b/packages/calcite-components/src/components/slider/readme.md index 0009cd9de24..fa593191d25 100644 --- a/packages/calcite-components/src/components/slider/readme.md +++ b/packages/calcite-components/src/components/slider/readme.md @@ -68,5 +68,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/sortable-list/readme.md b/packages/calcite-components/src/components/sortable-list/readme.md index acee16f8aa7..7f2c20ba969 100644 --- a/packages/calcite-components/src/components/sortable-list/readme.md +++ b/packages/calcite-components/src/components/sortable-list/readme.md @@ -28,5 +28,3 @@ | | A slot for adding sortable items. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/split-button/readme.md b/packages/calcite-components/src/components/split-button/readme.md index 948015150c3..e5fa7a9856b 100644 --- a/packages/calcite-components/src/components/split-button/readme.md +++ b/packages/calcite-components/src/components/split-button/readme.md @@ -67,5 +67,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/stack/readme.md b/packages/calcite-components/src/components/stack/readme.md index 41621926560..20749d95668 100644 --- a/packages/calcite-components/src/components/stack/readme.md +++ b/packages/calcite-components/src/components/stack/readme.md @@ -40,5 +40,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/stepper-item/readme.md b/packages/calcite-components/src/components/stepper-item/readme.md index f218dfab1dc..5ba530f6767 100644 --- a/packages/calcite-components/src/components/stepper-item/readme.md +++ b/packages/calcite-components/src/components/stepper-item/readme.md @@ -54,5 +54,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/stepper/readme.md b/packages/calcite-components/src/components/stepper/readme.md index e61df6621c8..99fc6b4d294 100644 --- a/packages/calcite-components/src/components/stepper/readme.md +++ b/packages/calcite-components/src/components/stepper/readme.md @@ -94,5 +94,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/switch/readme.md b/packages/calcite-components/src/components/switch/readme.md index 151d30ff50e..ffed168c0fa 100644 --- a/packages/calcite-components/src/components/switch/readme.md +++ b/packages/calcite-components/src/components/switch/readme.md @@ -47,5 +47,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tab-nav/readme.md b/packages/calcite-components/src/components/tab-nav/readme.md index 090526622d3..957275dce70 100644 --- a/packages/calcite-components/src/components/tab-nav/readme.md +++ b/packages/calcite-components/src/components/tab-nav/readme.md @@ -47,5 +47,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tab-title/readme.md b/packages/calcite-components/src/components/tab-title/readme.md index 555bf5ee109..8996dc0b1da 100644 --- a/packages/calcite-components/src/components/tab-title/readme.md +++ b/packages/calcite-components/src/components/tab-title/readme.md @@ -61,5 +61,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tab/readme.md b/packages/calcite-components/src/components/tab/readme.md index 94a83963d9b..3f1189be133 100644 --- a/packages/calcite-components/src/components/tab/readme.md +++ b/packages/calcite-components/src/components/tab/readme.md @@ -48,5 +48,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/table-cell/readme.md b/packages/calcite-components/src/components/table-cell/readme.md index e11e5bacd59..d40f4c84eeb 100644 --- a/packages/calcite-components/src/components/table-cell/readme.md +++ b/packages/calcite-components/src/components/table-cell/readme.md @@ -50,5 +50,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/table-header/readme.md b/packages/calcite-components/src/components/table-header/readme.md index 6c4d71d9b8a..7bdae2b36fe 100644 --- a/packages/calcite-components/src/components/table-header/readme.md +++ b/packages/calcite-components/src/components/table-header/readme.md @@ -52,5 +52,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/table-row/readme.md b/packages/calcite-components/src/components/table-row/readme.md index d9ec70296b3..b5541fb998c 100644 --- a/packages/calcite-components/src/components/table-row/readme.md +++ b/packages/calcite-components/src/components/table-row/readme.md @@ -51,5 +51,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/table/readme.md b/packages/calcite-components/src/components/table/readme.md index 6d1776e8c24..40ab6ab9fc9 100644 --- a/packages/calcite-components/src/components/table/readme.md +++ b/packages/calcite-components/src/components/table/readme.md @@ -63,5 +63,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tabs/readme.md b/packages/calcite-components/src/components/tabs/readme.md index fc77e06a00a..173e0cfc8ec 100644 --- a/packages/calcite-components/src/components/tabs/readme.md +++ b/packages/calcite-components/src/components/tabs/readme.md @@ -35,5 +35,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/text-area/readme.md b/packages/calcite-components/src/components/text-area/readme.md index bb030a13672..8f09beeb01f 100644 --- a/packages/calcite-components/src/components/text-area/readme.md +++ b/packages/calcite-components/src/components/text-area/readme.md @@ -96,5 +96,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tile-group/readme.md b/packages/calcite-components/src/components/tile-group/readme.md index 7a5595b4f54..729d972bac5 100644 --- a/packages/calcite-components/src/components/tile-group/readme.md +++ b/packages/calcite-components/src/components/tile-group/readme.md @@ -30,5 +30,3 @@ For comprehensive guidance on using and implementing `calcite-tile-group`, refer | | A slot for adding `calcite-tile` elements. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tile-select-group/readme.md b/packages/calcite-components/src/components/tile-select-group/readme.md index 7b9014b74fd..95580d1ae15 100644 --- a/packages/calcite-components/src/components/tile-select-group/readme.md +++ b/packages/calcite-components/src/components/tile-select-group/readme.md @@ -20,5 +20,3 @@ For comprehensive guidance on using and implementing `calcite-tile-select-group` | | A slot for adding `calcite-tile-select` elements. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tile-select/readme.md b/packages/calcite-components/src/components/tile-select/readme.md index 475853943a6..6d4ad043a93 100644 --- a/packages/calcite-components/src/components/tile-select/readme.md +++ b/packages/calcite-components/src/components/tile-select/readme.md @@ -64,5 +64,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tile/readme.md b/packages/calcite-components/src/components/tile/readme.md index 1b17744fd5b..60af049f674 100644 --- a/packages/calcite-components/src/components/tile/readme.md +++ b/packages/calcite-components/src/components/tile/readme.md @@ -73,5 +73,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/time-picker/readme.md b/packages/calcite-components/src/components/time-picker/readme.md index 407bf13915d..2c704498355 100644 --- a/packages/calcite-components/src/components/time-picker/readme.md +++ b/packages/calcite-components/src/components/time-picker/readme.md @@ -44,5 +44,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tip-group/readme.md b/packages/calcite-components/src/components/tip-group/readme.md index f7190aa8120..291864befe3 100644 --- a/packages/calcite-components/src/components/tip-group/readme.md +++ b/packages/calcite-components/src/components/tip-group/readme.md @@ -19,5 +19,3 @@ For comprehensive guidance on using and implementing `calcite-tip-group`, refer | | A slot for adding `calcite-tip`s. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tip-manager/readme.md b/packages/calcite-components/src/components/tip-manager/readme.md index 33e4cd598ba..746b3f69a28 100644 --- a/packages/calcite-components/src/components/tip-manager/readme.md +++ b/packages/calcite-components/src/components/tip-manager/readme.md @@ -70,5 +70,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tip/readme.md b/packages/calcite-components/src/components/tip/readme.md index 1806e16b090..0a7d3f3c4de 100644 --- a/packages/calcite-components/src/components/tip/readme.md +++ b/packages/calcite-components/src/components/tip/readme.md @@ -47,5 +47,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tooltip/readme.md b/packages/calcite-components/src/components/tooltip/readme.md index 65abe3a5ed4..b1bb89cab51 100644 --- a/packages/calcite-components/src/components/tooltip/readme.md +++ b/packages/calcite-components/src/components/tooltip/readme.md @@ -55,5 +55,3 @@ Type: `Promise` | `--calcite-tooltip-z-index` | Sets the z-index value for the component. | --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tree-item/readme.md b/packages/calcite-components/src/components/tree-item/readme.md index 92c5fa4467c..47d4adb1ade 100644 --- a/packages/calcite-components/src/components/tree-item/readme.md +++ b/packages/calcite-components/src/components/tree-item/readme.md @@ -38,5 +38,3 @@ graph TD; ``` --- - -*Built with [StencilJS](https://stenciljs.com/)* diff --git a/packages/calcite-components/src/components/tree/readme.md b/packages/calcite-components/src/components/tree/readme.md index 877d769e86c..50ee819319f 100644 --- a/packages/calcite-components/src/components/tree/readme.md +++ b/packages/calcite-components/src/components/tree/readme.md @@ -26,5 +26,3 @@ For comprehensive guidance on using and implementing `calcite-tree`, refer to th | | A slot for `calcite-tree-item` elements. | --- - -*Built with [StencilJS](https://stenciljs.com/)* From 86e5c9132891ee391f6e99fcd02ac9c3e5fe2715 Mon Sep 17 00:00:00 2001 From: DitwanP Date: Wed, 29 Jan 2025 16:07:30 -0800 Subject: [PATCH 6/8] feedback changes --- packages/calcite-components-react/README.md | 12 ++--- .../conventions/Documentation.md | 2 +- .../conventions/Internationalization.md | 17 ------- .../calcite-components/conventions/README.md | 46 ------------------- .../calcite-components/conventions/Styling.md | 4 -- .../calcite-components/conventions/Testing.md | 4 +- .../README.md | 4 +- .../docs/no-dynamic-createelement.md | 2 +- .../docs/strict-boolean-attributes.md | 4 +- 9 files changed, 8 insertions(+), 87 deletions(-) diff --git a/packages/calcite-components-react/README.md b/packages/calcite-components-react/README.md index ce6d6821cc3..732f022b3d5 100644 --- a/packages/calcite-components-react/README.md +++ b/packages/calcite-components-react/README.md @@ -16,9 +16,7 @@ There are two builds that are provided by the standard `calcite-components` pack ### Custom Elements build - - -[Custom Elements](https://stenciljs.com/docs/custom-elements) is the recommended build when using frontend frameworks, such as React. To use this build, you will need to set the path to the `calcite-components` assets. You can either use local assets, which will be explained in a subsequent step, or assets hosted on a CDN. +[Custom Elements](developers.arcgis.com/calcite-design-system/get-started#custom-elements) is the recommended build when using frontend frameworks, such as React. To use this build, you will need to set the path to the `calcite-components` assets. You can either use local assets, which will be explained in a subsequent step, or assets hosted on a CDN. ```jsx import { setAssetPath } from "@esri/calcite-components/dist/components"; @@ -40,9 +38,7 @@ import { CalciteButton, CalciteIcon, CalciteSlider } from "@esri/calcite-compone ### Dist build - - -When using the [Dist](https://stenciljs.com/docs/distribution) build, you'll need to manually define the custom elements on the window. You can also choose between local and CDN hosted assets. +When using the [Dist](developers.arcgis.com/calcite-design-system/get-started#distribution) build, you'll need to manually define the custom elements on the window. You can also choose between local and CDN hosted assets. ```jsx import { defineCustomElements } from "@esri/calcite-components/dist/loader"; @@ -89,10 +85,8 @@ function onUpdate(event) { setSliderValue(event.target.value); } -// TODO: Get suggestions for what this should be replaced with - // need to access the dom node to set custom event listeners for props that aren't strings / numbers -// https://stenciljs.com/docs/react#properties-and-events +// lit.dev/docs/frameworks/react#why-are-wrappers-needed useEffect( (_) => { sliderEl.current.addEventListener("calciteSliderUpdate", onUpdate); diff --git a/packages/calcite-components/conventions/Documentation.md b/packages/calcite-components/conventions/Documentation.md index aaa6c6c3d08..51ac154c4dd 100644 --- a/packages/calcite-components/conventions/Documentation.md +++ b/packages/calcite-components/conventions/Documentation.md @@ -25,7 +25,7 @@ There are two ways to document deprecations, depending on the API reference. In ### Usage snippets -You can provide code snippets demonstrating a specific behavior or pattern for a component. Within the component's directory, create a new `usage` directory. Then, create a Markdown file with the filename as the title of the snippet. There should only be one snippet per Markdown file. The usage snippets will be added to the component's README after building. These usage snippets will then be displayed in Storybook. +You can provide code snippets demonstrating a specific behavior or pattern for a component. In the component's directory, create a `usage` folder. Then, add a Markdown file named after the snippet's title, ensuring each file contains only one snippet. These usage snippets will be displayed in Storybook. ### Using utilities diff --git a/packages/calcite-components/conventions/Internationalization.md b/packages/calcite-components/conventions/Internationalization.md index 77809a4ba7b..36b7ffc1666 100644 --- a/packages/calcite-components/conventions/Internationalization.md +++ b/packages/calcite-components/conventions/Internationalization.md @@ -59,20 +59,3 @@ This pattern enables components to support built-in translations. In order to su - Placeholders in message bundle strings should: - Use the following syntax: `{placeholder}` (e.g., `Hello {userName}, my old friend. 👋`). - Have an expressive name to provide context regarding its use. - -## Translated strings - -**Note ⚠️**: this pattern is deprecated and should no longer be followed for future components! - -In the future it will likely become necessary to provide string translations for components. An example would be the `aria-label` for the `` close button. Initial research looks promising and we could likely implement one of these approaches and set a `lang` for each component. - - - -- ~~ and ~~ -- ~~~~ - -Until we implement a `lang` facility and set up translations for all components, we have been allowing a small number of strings to be passed in as properties. Properties that represent translated strings should have the syntax: `text-label-x`, where `x` is the name for the string. For example, when providing a string from "Close", use the property name `text-label-close`. In the component, these properties should default to their English equivalent (this is useful for non-localized apps): - -```tsx -@Prop() textLabelClose: string = 'Close'; -``` diff --git a/packages/calcite-components/conventions/README.md b/packages/calcite-components/conventions/README.md index 9e67ed2e708..c291a84e01f 100644 --- a/packages/calcite-components/conventions/README.md +++ b/packages/calcite-components/conventions/README.md @@ -328,18 +328,6 @@ const assetPath = getAssetPath(`./assets/my-component/asset.json`); This is required in order to have a unified assets folder in the distributable. -## Bundling and Loading - - - -Stencil has the capability to build and distribute a large variety of outputs based on our needs. You can read more about this in the [output targets](https://github.com/ionic-team/stencil/blob/cc55401555ff5c28757cf99edf372dcada2c0b25/src/compiler/output-targets/readme.md) documentation. - -As a best practice we should follow [Ionic's configuration](https://github.com/ionic-team/ionic/blob/master/core/stencil.config.ts) and generate a `bundle` for each component. Stencil will then generate a loader that will dynamically load the components used on the page. - -**Note:** This is highly likely to change as we move closer to our first release and as Stencil improves their documentation around their specific methods and build processes. - -Each root component should have a corresponding bundle entry in `stencil.config.ts`. - ## Unique IDs for Components Many times it is necessary for components to have a `id="something"` attribute for things like `