Skip to content

Review prop validation across component library #4651

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 task done
myrta2302 opened this issue Feb 11, 2025 · 1 comment · Fixed by #5469 · May be fixed by #5471 or #5472
Closed
1 task done

Review prop validation across component library #4651

myrta2302 opened this issue Feb 11, 2025 · 1 comment · Fixed by #5469 · May be fixed by #5471 or #5472
Assignees
@myrta2302
Labels
📦 components Related to the @swisspost/design-system-components package 🍀 decision Marks conversations where a decision has been made
Milestone
Maintenance IV

Comments

@myrta2302
Copy link
Contributor

myrta2302 commented Feb 11, 2025 •
edited
Loading

Following the alignment of prop validation messages (#4638), a review would be desirable as some components may lack prop validation or could benefit from enhancements.
@myrta2302 myrta2302 added the 🚂 PR train PR which follows another one. label Feb 11, 2025
@alizedebray alizedebray added this to the Maintenance III milestone Feb 12, 2025
@alizedebray alizedebray moved this from 👀 Triage to 💻 Ready for development in Design System Production Board Feb 12, 2025
@alizedebray alizedebray added 📦 components Related to the @swisspost/design-system-components package and removed 🚂 PR train PR which follows another one. labels Feb 12, 2025
@myrta2302 myrta2302 self-assigned this Mar 3, 2025
@myrta2302 myrta2302 moved this from 💻 Ready for development to 🕹️ Coding in progress in Design System Production Board Mar 3, 2025
@myrta2302 myrta2302 linked a pull request Mar 6, 2025 that will close this issue
chore(components): review and update prop validation across component library #4891
Open
@myrta2302 myrta2302 moved this from 🕹️ Coding in progress to 🤬 Dev in Code Review in Design System Production Board Mar 6, 2025
@gfellerph gfellerph moved this from 🤬 Dev in Code Review to 🧐 In Review in Design System Production Board Mar 13, 2025
@myrta2302 myrta2302 moved this from 🧐 In Review to 💻 In Progress in Design System Production Board Mar 18, 2025
@myrta2302 myrta2302 moved this from 💻 In Progress to 🧐 In Review in Design System Production Board Mar 31, 2025
@myrta2302 myrta2302 added the needs: 🏓 dev roundtable To be discussed at the roundtable of esteemed developers label Apr 3, 2025
@myrta2302
Copy link
Contributor Author

Decisions:

  1. We do not validate Boolean props
  2. We remove default 'null' values from declaration: (e.g. @prop() readonly rotate?: number | null = null; -> @prop() readonly rotate?: number;)
  3. We remove 'throw error' and use only 'console.error' everywhere

@myrta2302 myrta2302 added 🍀 decision Marks conversations where a decision has been made and removed needs: 🏓 dev roundtable To be discussed at the roundtable of esteemed developers labels Apr 3, 2025
@myrta2302 myrta2302 moved this from 🧐 In Review to 💻 In Progress in Design System Production Board Apr 7, 2025
@myrta2302 myrta2302 moved this from 💻 In Progress to 🧐 In Review in Design System Production Board Apr 14, 2025
This was linked to pull requests May 12, 2025
chore(components): review prop validation (#1) - props initialization #5469
Merged
chore(components): review prop validation (#2) - update validation functions and checkers #5471
Open
chore(components): review prop validation (#3) - replace throw error with console.error for all checker functions #5472
Open
chore(documentation): minor updates for back to top, card-control and popover. #5475
Closed
This was unlinked from pull requests May 12, 2025
chore(components): review and update prop validation across component library #4891
Open
chore(documentation): minor updates for back to top, card-control and popover. #5475
Closed
@myrta2302 myrta2302 linked a pull request May 12, 2025 that will close this issue
chore(components): review and update prop validation across component library #4891
Open
@myrta2302 myrta2302 removed a link to a pull request May 16, 2025
chore(components): review and update prop validation across component library #4891
Open
@myrta2302 myrta2302 mentioned this issue May 16, 2025
Open
@github-project-automation github-project-automation bot moved this from 🧐 In Review to 🚀 Done in Design System Production Board May 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@myrta2302 myrta2302

Labels
📦 components Related to the @swisspost/design-system-components package 🍀 decision Marks conversations where a decision has been made
Projects
Design System Production Board
Status: 🚀 Done
Milestone
Maintenance IV
3 participants
@gfellerph @alizedebray @myrta2302