Skip to content

Commit

Permalink
more explanations
Browse files Browse the repository at this point in the history
improved with more explanations about what is ready and what is WIP
  • Loading branch information
demarant committed Oct 21, 2022
1 parent 8c9374e commit a8b2272
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions templates/eea.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,37 @@ title: What's new

### EEA Design System (1.0.0-alpha)

#### Components
#### Components ready to be used

The following components are ready to be used as Volto `blocks`, `slate` integration or via the advanced `block styler`:
- Accordion `block`
- Call to Action `block`
- Callout - part of the Description `block`, `slate`
- Card - part of the Teaser `block` and Listing `block`
- Card - part of the Teaser `block` and Listing `block`, it includes several variations like round card e.g. used for Avatar (except the Landscape card variation- image on left/right)
- Content Box `block styler`
- Divider `block`
- Headings `slate`
- Hero `block`
- Item `block`
- List `slate`
- Item `block` - used for text with icon (remixicon or custom SVG/image) on the left/right.
- List `slate` - ordered and unordered (description list still WIP)
- Quote `block`
- Statistic `block`
- Tag `block`
- Table `block`
- Tabs `block`
- Timeline `block`

#### Work-in-progress

The following components can be used in Volto, but there is still work to be done and they may introduce breaking changes in the future releases:
- Navigation Portlet
- Tabs `block`
- Table `block`
Below a non-exhaustive list of the work-in-progress which is planned for the future releases:
- Navigation Portlet (used on the left / right hand of content) is still WIP, should not be used
- When using the Table `block`, please be aware to enable the responsive design manually (should be on by default in later releases)
- Description list (dt,dd) is still missing in slate
- Slate enhancements, e.g. inclusion of various font weights and text alignment (left, centered, right)
- Better theming engine across several components, e.g. a cosistent way to apply Primary, Secondary and Tertiary colors to element and automatic inversion of font text to white when necessary.
- Spacing / padding system via the `block styler`. We do have design-tokens. However these are not exposed to the volto block styler. We want to add the ability for editors to consistently apply various spacing/padding on certain components in order to allow a better alignment when components are used together.
- Harmonise components naming across docusarurus, storybook, code and Volto.
- Improve docusaurus and storybook with more components controls and variations in order to better reflect what is possible in Volto.

{{#unless options.hideCredit}}
Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
Expand Down

0 comments on commit a8b2272

Please sign in to comment.