CleverCloud / clever-components

Collection of Web Components by Clever Cloud
https://www.clever-cloud.com/doc/clever-components/
Apache License 2.0
220 stars 19 forks source link

Components/remove deprecated accessible name prop #976

Closed florian-sanders-cc closed 7 months ago

florian-sanders-cc commented 7 months ago

Context

With the 12.0.0 release, we have decided to deprecate the accessibleName property & accessible-name attribute (see #894).

With the 13.0.0, we are now removing this prop / attribute.

This PR removes the prop / attribute from components.

How to review?

Note: I've checked the console project and there is no usage of accessibleName / accessible-name. This means that we don't need to adapt the console to this breaking change when integrating the 13.0.0 release @pdesoyres-cc :+1:

github-actions[bot] commented 7 months ago

🔎 A preview has been automatically published : https://clever-components-preview.cellar-c2.services.clever-cloud.com/components/remove-deprecated-accessible-name-prop/index.html.

This preview will be deleted once this PR is closed.

florian-sanders-cc commented 7 months ago

@Galimede

* Not every component that has a `a11y-name` includes a note in their respective docs,  should we uniform it later on?

Do you have an example? Every component has a doc associated to their a11yName property within the constructor which should be enough for most cases. The docs are not always the same because the usecase and what the property actually generates differs depending on the inner HTML of the component (setting a11yName on cc-icon triggers the addition of different attributes compared to setting on cc-img for instance).

* Also `cc-icon` has a section title for its accessibility guidelines which is `**Accessibility guidelines:**` whereas in `cc-popover` it is `## Accessibility`. Maybe, we should decide which one we want to use. Or we can also decide to leave it to developer preference.

That's a good point, we could open a quick win issue about this but we'd also need to agree on what to use and write it in some of our docs for later :thinking:

florian-sanders-cc commented 7 months ago

@Galimede

* Not every component that has a `a11y-name` includes a note in their respective docs,  should we uniform it later on?

Do you have an example? Every component has a doc associated to their a11yName property within the constructor which should be enough for most cases. The docs are not always the same because the usecase and what the property actually generates differs depending on the inner HTML of the component (setting a11yName on cc-icon triggers the addition of different attributes compared to setting on cc-img for instance).

* Also `cc-icon` has a section title for its accessibility guidelines which is `**Accessibility guidelines:**` whereas in `cc-popover` it is `## Accessibility`. Maybe, we should decide which one we want to use. Or we can also decide to leave it to developer preference.

That's a good point, we could open a quick win issue about this but we'd also need to agree on what to use and write it in some of our docs for later 🤔

Discussed this with @Galimede in sync, we'll create an issue to standardize Accessibility sections for components when it's relevant.

github-actions[bot] commented 7 months ago

🔎 The preview has been automatically deleted.