This is the documentation for GOV.UK Vue. It's built with Nuxt.
Components in GOV.UK Vue are parsed with vue-docgen to extract props and slots.
Component documentation is in content/2.components. Vue component examples are converted to SFC .vue files by
server/plugins/content.ts. This allows us to show a rendered version of the example, as well as the code.
Documentation is generated by running npm run generate. This generates static files.
| Component | Docs? | Notes |
|---|---|---|
| Accordion | Yes | Change v-model syntax? |
| Back link | Yes | |
| Breadcrumbs | Yes | |
| Button | Yes | |
| Character count | Yes | |
| Checkboxes | Yes | |
| Cookie banner | Yes | |
| Date input | Yes | |
| Details | Yes | |
| Error message | Yes | |
| Error summary | Yes | |
| Exit this page | ||
| Fieldset | Yes | |
| File upload | Yes | |
| Footer | Yes | |
| Header | Yes | |
| Inset text | Yes | |
| Notification banner | Yes | |
| Pagination | ||
| Panel | Yes | |
| Phase banner | Yes | |
| Radios | Yes | |
| Select | Yes | |
| Skip link | Yes | |
| Summary list | Yes | |
| Table | Yes | |
| Tabs | Yes | |
| Tag | Yes | |
| Text input | Yes | |
| Textarea | Yes | |
| Warning text | Yes |