Welcome
RPF Design System - Rails
A gem with ViewComponent/Rails 7 based components for the Raspberry Pi Foundation Design System
Design System links:
Welcome to the Raspberry Pi Foundation's Design System Rails gem. This LookBook showcases the available components and provides examples of their usage. For each component, you can view a preview, examine the HTML code, and access the source code used to generate it. Find all previews in the sidebar, under 'Previews -> Design System'.
Example of a component preview
Under each preview there are three tabs: source
, notes
, and params
:
- The
source
tab shows the code used to generate the component as shown. - The
notes
tab provides documentation on how to use the component, what parameters it takes, code examples of how to call and use the component, and any additional information that may be useful. - The
params
tab allows you to adjust the component to see its various states. For instance, you may be able to change the text of a button, or the colour of a background, or choose how many items to display on a page.
To find out more about using this gem or contributing to it, please visit the repository on GitHub which has documentation for both.