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

Streamlined name changes to components to limit confusion #2512

Closed
bstifle opened this issue Jul 12, 2021 · 7 comments
Closed

Streamlined name changes to components to limit confusion #2512

bstifle opened this issue Jul 12, 2021 · 7 comments
Assignees
Labels
1 - assigned Issues that are assigned to a sprint and a team member. breaking change Issues and pull requests with code changes that are not backwards compatible. discussion Issues relating to a conversation where feedback is optional.

Comments

@bstifle
Copy link

bstifle commented Jul 12, 2021

Summary

Names of certain components are confusing or inconsistent with the naming of other components

Measure of Success

have component names changed to be more accurate and less confusing

Name change proposals

Calcite-tab-nav -> calcite-tab-title-group

Reasoning: Matches other child / parent component nomenclature,

Prevents conflation with upcoming calcite-nav / calcite-nav-*


Calcite-drill-in (not yet built) (don’t use calcite-flow-whatever)

Reasoning: Drill in is a common UI term, and it can be used outside the scope of a flow or panel


Calcite-list, calcite-value-list, calcite-pick-list -> just-one-list-thing

Reasoning: If possible, make “value” and “pick” types of “the basic list component”.


Calcite-inline-editable -> calcite-….input-editable? Editable as prop?

Reasoning: Inline-editable doesn’t have a relationship to input. It’s also the only “adjective” component name.

If possible, make “editable” or “inline” or whatever a prop on input (and later textarea)


Rework Tabs, TabNav, Tab naming story

Reasoning: Tabs is the only one with a plural.

The 3 components to build a group of tabs is confusing. Consider renaming each to make it easier to understand the layers of functionality


radio button / radio button group / radio group

Reasoning: confusing name hopscotch.

Radio Button -> (no change)
Radio Button Group -> (no change)
Radio Group -> Radio Rectangle, Rectangle Radio, etc

@bstifle bstifle added tooling Issues relating to build system fixes or improvements. 0 - new New issues that need assignment. needs triage Planning workflow - pending design/dev review. and removed tooling Issues relating to build system fixes or improvements. labels Jul 12, 2021
@jcfranco jcfranco added 1 - assigned Issues that are assigned to a sprint and a team member. and removed 0 - new New issues that need assignment. needs triage Planning workflow - pending design/dev review. labels Jul 15, 2021
@julio8a julio8a added needs triage Planning workflow - pending design/dev review. 0 - new New issues that need assignment. and removed 1 - assigned Issues that are assigned to a sprint and a team member. labels Jul 21, 2021
@bstifle
Copy link
Author

bstifle commented Jul 22, 2021

salesforce calls its version of radio group, "Listbox"

https://www.lightningdesignsystem.com/accessibility/patterns/listbox/

@jcfranco jcfranco removed the needs triage Planning workflow - pending design/dev review. label Jul 29, 2021
@jcfranco jcfranco added this to the Sprint 8/2 – 8/13 milestone Jul 29, 2021
@jcfranco jcfranco added 1 - assigned Issues that are assigned to a sprint and a team member. discussion Issues relating to a conversation where feedback is optional. and removed 0 - new New issues that need assignment. labels Jul 29, 2021
@julio8a
Copy link

julio8a commented Aug 3, 2021

Tabs

Clean up the amount of children

<calcite-tabs ...>
  <calcite-tab heading=title ...>content</calcite-tab>
  <calcite-tab heading=title ...>content</calcite-tab>
  <calcite-tab heading=title ...>content</calcite-tab>
</calcite-tabs>

Calcite-Flow

Rename to Calcite-drill-in, following standard naming for this component

Calcite-inline-editable

integrate with input and make a prop

Radio

Bring the radio group into the larger radio story
https://mdbootstrap.com/snippets/jquery/marta-szymanska/593151
https://ant.design/components/radio/#Radio/Radio.Button

@jcfranco
Copy link
Member

jcfranco commented Aug 9, 2021

I think we've narrowed down the list of changes. Moving this to the freezer until we get closer to the batch renaming beta release.

@jcfranco
Copy link
Member

Via #1616, should we drop the -picker from calcite-input-<type>-picker?

From @eriklharper:

I prefer the name calcite-input-color over calcite-input-color-picker for the same reason I prefer calcite-input-time over calcite-input-time-picker. No need to have the -picker at the end when the last word is sufficient for communicating the type of input it is.

@julio8a
Copy link

julio8a commented Aug 24, 2021

For the input-based, I think it makes sense to use just color, time, date since you know what and where it will go into.

For general components, I'd like to keep picker and stay consistent with other frameworks:

Shopify:
image

Salesforce:
image

Vuetify:
image

@macandcheese
Copy link
Contributor

macandcheese commented Aug 24, 2021

Couple thoughts... Agree on most of the above. I think across the board the nomenclature could be standardized more... we use a lot of non-recognizable terms that folks not familiar with the system won't be looking for. We can obviously try to educate and promote but it seems like we just try to stick to more industry standard terms as a rule.

For tabs - I like the change to 'tab-title-group'. I don't particularly mind the plural 'tabs' - this is seen across most design system examples I can find. There is maybe something to clean up in the inconsistency with stepper (fwiw - a singular name on Carbon https://www.carbondesignsystem.com/components/progress-indicator/usage/), but that also is commonly seen across systems.

To me as a consumer, the number of "list" components is overwhelming. I know we are trying to prescribe behavior but trying to choose between them can be tough - even if comprehensive documentation is available it's still on the user to educate themselves. The child components are all very similar and a generic group component would be useful in all cases - short of combining the parent components, can they share a generic group and child item?

@driskull driskull self-assigned this Dec 7, 2022
@geospatialem geospatialem added the breaking change Issues and pull requests with code changes that are not backwards compatible. label Dec 7, 2022
@geospatialem
Copy link
Member

Closing in favor of the two above issues, 6152 and 6153 and with the refactor of tabs in #2721.

The remaining component name changes are no longer considered or valid since the original issue was opened.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - assigned Issues that are assigned to a sprint and a team member. breaking change Issues and pull requests with code changes that are not backwards compatible. discussion Issues relating to a conversation where feedback is optional.
Projects
None yet
Development

No branches or pull requests

6 participants