Skip to content

Added common features component.#948

Open
EHandtkeBasis wants to merge 2 commits into
mainfrom
64-structuring-fields
Open

Added common features component.#948
EHandtkeBasis wants to merge 2 commits into
mainfrom
64-structuring-fields

Conversation

@EHandtkeBasis
Copy link
Copy Markdown
Member

closes #64

- **Accessibility**: Utilize the `NumberField` component with accessibility in mind, adhering to accessibility standards such as proper labeling, keyboard navigation support, and compatibility with assistive technologies. Ensure that users with disabilities can interact with the `NumberField` effectively.

- **Utilize Increment/Decrement Buttons**: If appropriate for your app, consider utilizing increment and decrement buttons with the `NumberField`. This allows users to adjust the numeric value by a specific increment or decrement with a single click. No newline at end of file
- **Utilize Increment/Decrement Buttons**: If appropriate for your app, consider utilizing increment and decrement buttons with the `NumberField`. This allows users to adjust the numeric value by a specific increment or decrement with a single click.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[webforJ.Simplify] Consider 'use' instead of 'Utilize'.

- **Accessibility**: Utilize the `NumberField` component with accessibility in mind, adhering to accessibility standards such as proper labeling, keyboard navigation support, and compatibility with assistive technologies. Ensure that users with disabilities can interact with the `NumberField` effectively.

- **Utilize Increment/Decrement Buttons**: If appropriate for your app, consider utilizing increment and decrement buttons with the `NumberField`. This allows users to adjust the numeric value by a specific increment or decrement with a single click. No newline at end of file
- **Utilize Increment/Decrement Buttons**: If appropriate for your app, consider utilizing increment and decrement buttons with the `NumberField`. This allows users to adjust the numeric value by a specific increment or decrement with a single click.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[webforJ.Simplify] Consider 'using' instead of 'utilizing'.

- **Spell Checking and Auto-Complete**: When applicable, consider utilizing spellchecking with `setSpellCheck()` and/or using autocomplete in a `TextField`. These features can help users input information faster and reduce errors by providing suggested values based on previous inputs or predefined options.

- **Accessibility**: Utilize the `TextField` component with accessibility in mind, adhering to accessibility standards such as proper labeling, keyboard navigation support, and compatibility with assistive technologies. Ensure that users with disabilities can interact with the `TextField` effectively. No newline at end of file
- **Accessibility**: Utilize the `TextField` component with accessibility in mind, adhering to accessibility standards such as proper labeling, keyboard navigation support, and compatibility with assistive technologies. Ensure that users with disabilities can interact with the `TextField` effectively.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[webforJ.Simplify] Consider 'use' instead of 'Utilize'.

- **Spell Checking and Auto-Complete**: When applicable, consider utilizing spellchecking with `setSpellCheck()` and/or using autocomplete in a `TextField`. These features can help users input information faster and reduce errors by providing suggested values based on previous inputs or predefined options.

- **Accessibility**: Utilize the `TextField` component with accessibility in mind, adhering to accessibility standards such as proper labeling, keyboard navigation support, and compatibility with assistive technologies. Ensure that users with disabilities can interact with the `TextField` effectively. No newline at end of file
- **Accessibility**: Utilize the `TextField` component with accessibility in mind, adhering to accessibility standards such as proper labeling, keyboard navigation support, and compatibility with assistive technologies. Ensure that users with disabilities can interact with the `TextField` effectively.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[webforJ.BeDirect] Avoid using 'Ensure that'. Focus more on explicitly giving details about the feature.

Copy link
Copy Markdown
Member

@bbrennanbasis bbrennanbasis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. From Issue #64

Ungroup the field components and divide each into its own section.

Does we still want the field components to be on the same TOC level as the rest of the components? What about the masked fields? If this involves moving the file structure, then we'd need to make sure to fix links to these articles.

  1. FieldCommonFeatures is missing from the masked fields, and keep in mind the masked articles already have the styling sections.

  2. Spellcheck is a shared field feature, but feels unimportant to include for non-text fields like colorfield.

  3. The elements in the AccordionSummary for this are <b> tags, but for MCP Server they're <strong> tags, then for Minifier Plugin they're <p> tags. It would be wise to choose one element going forward so we can keep a consistent style across articles.

  4. Common field features, the header for these sections, doesn't appear in the TOC. TableBuilder includes a function to add the various headers, but since FieldCommonFeatures only has one header that seems like overkill. My suggestion would be moving it outside of the component:

    ## Common field features {#common-field-features)
    <FieldCommonFeatures />
    
  5. Make the content within FieldCommonFeatures translatable. Use PR #861 and Docusaurus's Translate your React code for reference.

  6. Is the correct client component being documented in the ColorField style section? The rendered FieldCommonFeatures is showing the details for dwc-color-chooser, but in the DOM the ColorField component renders as a dwc-field:

Image

Regardless, _dwc_control_map.json and FieldCommonFeatures incorrectly label the ColorField component. For both cases, replace Color-Chooser with ColorField.

Image

@bbrennanbasis bbrennanbasis added the status: waiting-for-author Review is done. Waiting for the PR author to apply changes or respond. label May 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: waiting-for-author Review is done. Waiting for the PR author to apply changes or respond.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Structuring Field Articles with Accordions

3 participants