Create speculative APIs for each components - Githubissues

alphagov / govuk-frontend

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.

https://frontend.design-system.service.gov.uk/

MIT License

1.18k stars 323 forks source link

Create speculative APIs for each components #5147

Open romaricpascal opened 3 months ago

romaricpascal commented 3 months ago

What

Design a public API for each of our components as a base for discussion with the community and other teams. This includes:

methods
events
new options (including callbacks)

Why

This should facilitate and speed up discussions around what's useful to services.

Who needs to work on this

Developers

Who needs to review this

Developers

Done when

We've gone through our components and designed a public API for each of them as a base for discussion:

[ ] Accordion
[ ] Button
[ ] Character Count
[ ] Checkboxes
[ ] Error summary
[ ] Exit This Page
[ ] Header
[ ] Notification Banner
[ ] Radios
[ ] Skip Link
[ ] Tabs

romaricpascal commented 3 months ago

We've set up a Padlet board to discuss with our community which features each component could offer.