docs: audit api reference descriptions for style guide consistency #13687
Conversation
DitwanP
added
the
skip visual snapshots
geospatialem
left a comment
geospatialem
left a comment
There was a problem hiding this comment.
Awesome, @DitwanP! 🙌🏻 Similar to Mel's PR it looks like there are a number of changes that would apply across components - for consistency we will need to make a call across all components.
If we do decide to adopt new accepted language across components, we could add a new list of updates that could be applied to the related issue for us to follow with the doc consistency effort.
cc @Esri/calcite-pes
| //#region Public Properties | ||
|
|
||
| /** Specifies the accessible label for the last `calcite-action-group`. */ | ||
| /** Specifies an accessible name for the last `calcite-action-group`. */ |
There was a problem hiding this comment.
Think this would still be a label rather than name?
| @property({ reflect: true }) expanded = false; | ||
|
|
||
| /** Accessible name for the component. */ | ||
| /** Specifies an accessible name for the component. */ |
There was a problem hiding this comment.
Similar to feedback on @DintaMel's PR, we should align on common language to the label property across components.
| * Specifies the type of positioning to use for overlaid content, where: | ||
| * | ||
| * Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. | ||
| * `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | ||
| * `"absolute"` positions the component inside of overflowing parent containers and will affect the container's layout, and | ||
| * | ||
| * `"fixed"` is used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. |
There was a problem hiding this comment.
Similar to the label property, we should align on language across components.
| @property({ reflect: true }) overlayPositioning: OverlayPositioning = "absolute"; | ||
|
|
||
| /** Arranges the component depending on the element's `dir` property. */ | ||
| /** Specifies the position of the component depending on the element's `dir` property. */ |
There was a problem hiding this comment.
It looks like the same language is used in action-pad should we keep it as-is or change for both for consistency? Possibly even use "Positions the component..."? cc @Esri/calcite-pes
| @property({ reflect: true }) inputValueMatchPattern: RegExp; | ||
|
|
||
| /** Accessible name for the component. */ | ||
| /** Specifies an accessible name for the component. */ |
There was a problem hiding this comment.
Same as other properties for consistency, similar to feedback in Mel's PR for alignment with label.
| @property() inputValue: string; | ||
|
|
||
| /** Accessible name for the component. */ | ||
| /** Specifies an accessible name for the component. */ |
There was a problem hiding this comment.
Similar to the label property above for naming consistency across components.
| * Specifies the type of positioning to use for overlaid content, where: | ||
| * | ||
| * Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. | ||
| * `"absolute"` positions the component inside of overflowing parent containers and will affect the container's layout, and | ||
| * | ||
| * `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | ||
| * `"fixed"` is used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. |
There was a problem hiding this comment.
Similar to the overlayPositioning property above for naming consistency across components.
|
|
||
| /** | ||
| * Determines where the component will be positioned relative to the container element. | ||
| * Specifies where the component is positioned relative to the container element. |
There was a problem hiding this comment.
There are a few components with similar language, when agreed upon language, we should add this to the list in the original issue for future doc consistency suggestions. 💪🏻
|
|
||
| /** | ||
| * The current validation state of the component. | ||
| * Specifies the current validation state of the component. |
There was a problem hiding this comment.
There are a few components with similar language, when agreed upon language, we should add this to the list in the original issue for future doc consistency suggestions. 💪🏻
Co-authored-by: Kitty Hurley <[email protected]>
…-group.tsx Co-authored-by: Kitty Hurley <[email protected]>
Related Issue: #12833
Summary
Audit following components for doc style guid consistency:
action-menu(Internal)