search

visual-framework / vf-core

A (primarily CSS) framework that targets needs of life science websites and services
https://stable.visual-framework.dev/
Apache License 2.0
20 stars 10 forks source link

Add documentation for VF-list #1997

Closed Adedoyinebi closed 3 months ago

Adedoyinebi commented 4 months ago

The vf-list component currently has no documentation providing guidance on how to use the component or the variants available. The task here is to add documentation for this component on the vf-site.

Adedoyinebi commented 4 months ago

Consider if there are cases that require different colour (Primary and secondary text colours) and document guidance for such cases

stefangutnick commented 4 months ago

I have written a first draft of the documentation here to be reviewed. @Adedoyinebi In what cases might someone need to have different colours in a list? We should discuss to see if that's a use case, hopefully would like to avoid it if possible?

https://docs.google.com/document/d/1UXtYqySvCKG9WtnraUy6mgTr1aZ9-NNZDPtmiwhHFXY/edit?usp=sharing

Adedoyinebi commented 3 months ago

Documentation has been created by @stefangutnick for the Vf-list component. Accessibility checks have also been done by Carla.

Next steps

Issue has been added to follow up on the code issue found, and to update the document on the vf site