Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update filtering.mdx #3495

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update filtering.mdx #3495

wants to merge 2 commits into from

Conversation

SOjaHPE
Copy link
Collaborator

@SOjaHPE SOjaHPE commented Aug 1, 2023

Some of the terminating markdown emphasis "**" chars were missing and messed up the formatting when rendering the Guidelines section.

Deploy Preview

What does this PR do?

Where should the reviewer start?

What testing has been done on this PR?

In addition to the feature you are implementing, have you checked the following:

General UX Checks

  • Small, medium, and large screen sizes
  • Cross-browsers (FireFox, Chrome, and Safari)
  • Light & dark modes
  • All hyperlinks route properly

Accessibility Checks

  • Keyboard interactions
  • Screen reader experience
  • Run WAVE accessibility plugin (Chrome)

Code Quality Checks

  • Console is free of warnings and errors
  • Passes E2E commit checks
  • Visual snapshots are reasonable

How should this be manually tested?

Any background context you want to provide?

What are the relevant issues?

Screenshots (if appropriate)

Should this PR be mentioned in Design System updates?

Is this change backwards compatible or is it a breaking change?

Some of the terminating emphasis double "**" were missing and messed up the formatting of the Guidelines section.
- **Is the user going to be selecting from 4 or fewer multiple selection options?** Filter with
[CheckBoxGroup](#filters-in-a-center-layer).
- **If the filter set allows for multiple selections and there are 5 or more items to choose from, use [SelectMultiple](/components/SelectMultiple).
- **When the data contains 10 or more items, consider including search in your [SelectMultiple](/components/SelectMultiple) implementation.
- **If the filter set allows for multiple selections and there are 5 or more items to choose from?** Use [SelectMultiple](/components/SelectMultiple).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why add the question mark? It's not exactly a question

- **If the filter set allows for multiple selections and there are 5 or more items to choose from, use [SelectMultiple](/components/SelectMultiple).
- **When the data contains 10 or more items, consider including search in your [SelectMultiple](/components/SelectMultiple) implementation.
- **If the filter set allows for multiple selections and there are 5 or more items to choose from?** Use [SelectMultiple](/components/SelectMultiple).
- When the data contains 10 or more items, consider including search in your [SelectMultiple](/components/SelectMultiple) implementation.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Seems like this line still needs the ** as does line 94. At least it looks odd compared to the others

Fixed the wording to be consistent across the bullet points. Added emphasis to keep them all looking the same.
- **Is the user going to be selecting from 4 or fewer multiple selection options?** Filter with
[CheckBoxGroup](#filters-in-a-center-layer).
- **If the filter set allows for multiple selections and there are 5 or more items to choose from, use [SelectMultiple](/components/SelectMultiple).
- **When the data contains 10 or more items, consider including search in your [SelectMultiple](/components/SelectMultiple) implementation.
- **If the filter set allows for multiple selections and there are 5 or more items to choose from?** Use [SelectMultiple](/components/SelectMultiple).
Copy link
Collaborator

@taysea taysea Sep 5, 2023

Choose a reason for hiding this comment

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

Suggested change
- **If the filter set allows for multiple selections and there are 5 or more items to choose from?** Use [SelectMultiple](/components/SelectMultiple).
- **Does the filter set allow for multiple selections and are there 5 or more items to choose from?** Use [SelectMultiple](/components/SelectMultiple).

Maybe this is better wording @MikeKingdom ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants