Skip to content
This repository has been archived by the owner on Jun 29, 2023. It is now read-only.

Enhancement: Rename text props we provide a default for to have intl- prefix #818

Closed
18 tasks done
driskull opened this issue Feb 11, 2020 · 7 comments
Closed
18 tasks done
Assignees
Labels
4 - verified architecture doc Anything related to documentation enhancement New feature request for an existing component intl p - medium
Milestone

Comments

@driskull
Copy link
Member

driskull commented Feb 11, 2020

Description

Enhancement: Rename text props we provide a default for to have intl- prefix

Acceptance Criteria

All properties that we provide default text in English be prefixed with intl- so that we can document the purpose of these properties and have them named consistently.

Relevant Info

Also consider having a bundle file where we can reuse some of the common English strings for the defaults.

Which Component

All

Example Use Case

  • text-close => intl-close
  • text-back => intl-back

Props to change

calcite-action-bar

  • textExpand => intlExpand
  • textCollapse => intlCollapse

calcite-action-pad

  • textExpand => intlExpand
  • textCollapse => intlCollapse

calcite-block

  • textExpand => intlExpand
  • textCollapse => intlCollapse

calcite-block-section

  • textExpand => intlExpand
  • textCollapse => intlCollapse

calcite-filter

  • textLabel => label
  • textPlaceholder => placeholder

calcite-flow-item

  • textBack => intlBack
  • textClose => intlClose
  • textOpen => intlOpen

calcite-panel

  • textClose => intlClose

calcite-tip

  • textClose => intlClose

calcite-tip-manager

  • textClose => intlClose
  • textNext => intlNext
  • textPrevious => intlPrevious
@driskull driskull added enhancement New feature request for an existing component 1 - assigned p - medium architecture doc Anything related to documentation breaking This introduces a breaking change. labels Feb 11, 2020
@driskull driskull added this to the Ice King milestone Feb 11, 2020
@driskull driskull self-assigned this Feb 11, 2020
@driskull
Copy link
Member Author

@jcfranco @asangma do we want to do this as a breaking change or as deprecations?

@jcfranco
Copy link
Member

I vote to deprecate and remove later.

@driskull
Copy link
Member Author

driskull commented Feb 13, 2020

moved to top

@driskull driskull changed the title Enhancement: Rename text props we provide a default for to have locale- prefix Enhancement: Rename text props we provide a default for to have intl- prefix Feb 19, 2020
@driskull driskull removed the breaking This introduces a breaking change. label Feb 20, 2020
@driskull
Copy link
Member Author

@jcfranco do you think you could take the block and filter?

@driskull driskull added the intl label Feb 21, 2020
@jcfranco
Copy link
Member

@driskull Sure thing.

@kat10140 kat10140 modified the milestones: Ice King, James Baxter Mar 10, 2020
driskull added a commit that referenced this issue Mar 12, 2020
* #818 deprecate text for locale (action-bar & action-pad)

* stories

* rename locale to intl

* readmes

* use intl in stories

* cleanup

* put TEXT back in resources
@kat10140
Copy link
Contributor

looks good. any reason we don't have intlPlaceholder for filter? closing

@driskull
Copy link
Member Author

any reason we don't have intlPlaceholder for filter? closing

Because we don't supply a default value for it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
4 - verified architecture doc Anything related to documentation enhancement New feature request for an existing component intl p - medium
Projects
None yet
Development

No branches or pull requests

3 participants