Rewards Design System CSS

This repo contains the CSS part of the Rewards Design System.

How it works

Brand and design variables are stored as design tokens, using yaml format. These are transformed into web styles (scss and css variables) using Theo. (TODO: iOS and Android related style formats can be generated). The resulting rds.css file is published to npm repository rewards-ds-css.

The Rewards DS CSS currently uses Bulma CSS framework as a base.

How to consume

Reference the rds stylesheet in the HTML head:

<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/rds.css"/>

How to build

npm run generate-tokens This will transform the tokens into scss files

npm run build This will generate the css files from scss files

TODO

• Decide which design tokens to store [IN PROGRESS]
  • Convert more values into tokens eg break points, borders, form styling [TO DO]
• Port custom rds styles from current rewards-ds

  • core.scss

    • colour [DONE]
    • typography [DONE]
    • mixins [DONE] moved one and only mixins into typography
    • spacing [DONE] spacing helpers moved here
    • layout [DONE] (moved rds custom import into bulma import)
    • grid [DONE] (moved rds custom import into bulma import)
    • icons [SKIPPED] - currently relies on custom icomoon font
    • TODO: create new icon component and port references to custom icomoon font and replace in relevant components
    • helpers [DONE] - helpers included in spacing
    • shadows [DONE];

  • forms.scss [DONE] - this was just including bulma form scss .. have removed this and updated bulma.scss. forms.scss is now under rds and has rds cusomisations only

  • elements.scss [IN PROGRESS] - not sure how helpful the elements category is.

    • form.scss [DONE]
      • checkradio TO DO checkradio css seems bloated and should be reviewed
    • buttons.scss [DONE] - moved to misc
    • delete.scss [DONE] - moved to misc
    • checkradio [DONE] moved inside forms
    • divider.scss [REMOVED] no component uses is-divider class. duplicate animation
    • image.scss [DONE] - moved to misc

Next to do

• minify css output (source maps, remove comments etc)
• (maybe) create 'skeleton' css with just tokens and font
• exclude certain tokens from css variables
• verify if use of jsDelvr CDN is adequate
• consider if Roboto should be default sans serif (as before). currently set to default font stack (ie. changes with OS). i think this looks better

  In existing rewards-ds:

  • Reference rewards-css-ds
    • import rewards-ds-css [DONE]
    • update stencil.config.ts [DONE]
    • fix broken scss references [DONE]
    • replaces instances of local /build/rds.css with CDN reference to this css library [DONE BUT HARDCODED]
    • remove references to bulma mixins - how? [TO DO]
    • review all copmoents and remove @imports if possible [TO DO]
  • Check which components look different [TO DO]
  • Fix components [TO DO]
  • Remove local css
• Create / update icon component that references SVGs inline [TO DO]
• Update any components that use font-awesome icons to use new icon component (since font awesome wont be used in rewards-ds-css) [TO DO]

In OAP and Rendering layer

• Consume new css rather than rewards-ds css
• Regression test and fix any issues

Proposed rewards-ds heirarchy

• rewards-ds-css (css)
  • rewards-ds (web components stencil - requires css global)
  • rewards-ds-widgets (web components stencil that are 'smart' and/or encapsulated - requires just skeleton css)