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

Inconsistent key names for same properties #61

Closed
boxadesign opened this issue Feb 27, 2020 · 5 comments
Closed

Inconsistent key names for same properties #61

boxadesign opened this issue Feb 27, 2020 · 5 comments
Assignees
Labels
Documentation Improvements or additions to documentation Low Priority Spike

Comments

@boxadesign
Copy link

boxadesign commented Feb 27, 2020

Within the design system there is an inconsistent approach to naming keys. i.e.

When dealing with a component that has a some text and a href (nav, service nav, language etc) we don't use the same name conventions. Navigation uses title and path and service navigation uses text and url.

We need to review and update so we use consistent key names.

@boxadesign boxadesign added the Bug Something isn't working label Feb 27, 2020
@jrbarnes9 jrbarnes9 added Documentation Improvements or additions to documentation and removed Bug Something isn't working labels Jan 27, 2022
@yatesn
Copy link
Collaborator

yatesn commented Nov 16, 2023

Small change, but would need to look across DS to find instances of this

@alessioventuriniAND
Copy link

We need to decide what naming convention we want to implement. Also it would be good to add the list of components impacted by this change during our tech session.

@rmccar rmccar added the Spike label Feb 1, 2024
@rmccar
Copy link

rmccar commented Feb 1, 2024

Investigate the components that have these param in the DS and make a list of them alongside the params they use. We will then use this information to make a decision on which way we want to go with it in a tech session.

@daniellecorke
Copy link

To be started after the unnecessary conditionals work ONSdigital/design-system#3013 to ONSdigital/design-system#3026.

@precious-onyenaucheya-ons
Copy link

precious-onyenaucheya-ons commented Jun 18, 2024

Components with inconsistencies

  1. Access Code

    • postTextboxLinkText
    • postTextboxLinkUrl
  2. Address Input

    • ManualLinkText
    • ManualLink
  3. Breadcrumbs

    • text
    • url
  4. Button

    • text
    • url
  5. Call to Action (CTA)

    • text
    • url
  6. Card

    • title
    • text
    • url
  7. Content Pagination

    • text
    • url
  8. Cookies Banner

    • settingsLinkText
    • settingsLinkTextUrl
  9. Document List

    • Document:
      • title
      • url
    • Type:
      • text
      • url
  10. External Link

    • linkText
    • url
  11. Feedback

    • linkText
    • url
  12. Footer

    • oglLink:
      • link
      • url
  13. Header

    • Language:
      • text
      • url
    • Item:
      • text
      • url
    • signOutButton:
      • text
      • url
  14. Hero

    • button:
      • text
      • url
  15. Image

    • url
  16. Input

    • postTextboxLinkText
    • postTextboxLinkUrl
  17. Language Selector

    • text
    • url
  18. List

    • title
    • text
    • navigationTitle
    • url
  19. Message

    • UnreadLinkText
    • UnreadLink
  20. Message List

    • subject
    • url
  21. Navigation

    • title
    • text
    • url
  22. Reply

    • closeLinkText
    • closeLinkUrl
  23. Section Navigation

    • title
    • url
  24. Share Page

    • pageTitle
    • pageURL
  25. Skip to Content

    • text
    • url
  26. Summary

    • url
    • text
  27. Table

    • text
    • url
  28. Table of Content

    • text
    • url
  29. Video

    • linkText
    • videoLinkURL
    • title
    • videoEmbedUrl

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Low Priority Spike
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants