search

alphagov / govuk-design-system

One place for service teams to find styles, components and patterns for designing government services.
https://www.gov.uk/design-system
MIT License
492 stars 230 forks source link

Some utility and override classes are undocumented #2739

Open joelanman opened 1 year ago

joelanman commented 1 year ago

Context

Trying to use classes such as govuk-!-display-none or govuk-visually-hidden. I couldn't find any documentation of them, a list would be good like the Sass API documentation.

Update:

Some classes are documented in the Styles section: https://design-system.service.gov.uk/styles

But I don't think they all are, and personally I'd find an API style list helpful

Alternatives

I guessed and got it right, I've heard that others look at the Frontend Review app, or look in Chrome Developer Tools > Styles

Additional information (if applicable)

On hiding things specifically, I can see Design System website uses hidden attribute instead - is this a recommended approach? Should that be documented too?

36degrees commented 1 year ago

I'm moving this to the Design System repo as I think it's a better place for it than the frontend repo. However we might also want to consider documenting these in the Frontend Docs.

querkmachine commented 1 year ago

It seems like we currently have most utility and override classes now documented somewhere in the Design System, with govuk-clearfix and govuk-form-group being the main holdouts.