generated from eea/volto-addon-template
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added page-header,footer and grid in docusaurus
rest are prettier changes
- Loading branch information
1 parent
02d75fc
commit 660c8e3
Showing
68 changed files
with
431 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: Intro | ||
description: EEA Button Component | ||
hide_table_of_contents: true | ||
--- | ||
|
||
# Templates | ||
|
||
The core website minimises the duplication of content across the European Commission services. The site hosts general information shared with many different websites or departments. The core website is the hub for users to navigate to other thematic content and/or specific services such as web information system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Page Header | ||
description: EEA Button Component | ||
hide_table_of_contents: true | ||
--- | ||
|
||
import EEATabs from '../md_components/tab_component.mdx'; | ||
import Usage from '../md_components/page_header_components/usage_markdown.md'; | ||
import Showcase from '../md_components/page_header_components/showcase_markdown.md'; | ||
import Api from '../md_components/page_header_components/api_markdown.md'; | ||
|
||
<EEATabs usage={<Usage />} showcase={<Showcase />}></EEATabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Component Grid | ||
description: EEA Button Component | ||
hide_table_of_contents: true | ||
--- | ||
|
||
import EEATabs from '../../md_components/tab_component.mdx'; | ||
import Usage from '../../md_components/component_grid_components/usage_markdown.md'; | ||
import Showcase from '../../md_components/component_grid_components/showcase_markdown.md'; | ||
import Api from '../../md_components/component_grid_components/api_markdown.md'; | ||
|
||
<EEATabs usage={<Usage />} showcase={<Showcase />}></EEATabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Layout Grid | ||
description: EEA Button Component | ||
hide_table_of_contents: true | ||
--- | ||
|
||
import EEATabs from '../../md_components/tab_component.mdx'; | ||
import Usage from '../../md_components/layout_grid_components/usage_markdown.md'; | ||
import Showcase from '../../md_components/layout_grid_components/showcase_markdown.md'; | ||
import Api from '../../md_components/layout_grid_components/api_markdown.md'; | ||
|
||
<EEATabs usage={<Usage />} showcase={<Showcase />}></EEATabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Page Footer | ||
description: EEA Button Component | ||
hide_table_of_contents: true | ||
--- | ||
|
||
import EEATabs from '../md_components/tab_component.mdx'; | ||
import Usage from '../md_components/page_footer_components/usage_markdown.md'; | ||
import Showcase from '../md_components/page_footer_components/showcase_markdown.md'; | ||
import Api from '../md_components/page_footer_components/api_markdown.md'; | ||
|
||
<EEATabs usage={<Usage />} showcase={<Showcase />}></EEATabs> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 3 additions & 2 deletions
5
website/docs/md_components/breadcrumb_components/showcase_markdown.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,9 @@ | ||
import Iframe from '../iframe_component.mdx'; | ||
|
||
## Default | ||
<Iframe id='components-breadcrumb-breadcrumb-2--default' > </Iframe> | ||
|
||
<Iframe id='components-breadcrumb-breadcrumb-2--default' > </Iframe> | ||
|
||
## Icons | ||
<Iframe id='components-breadcrumb-breadcrumb-1--breadcrumb' > </Iframe> | ||
|
||
<Iframe id='components-breadcrumb-breadcrumb-1--breadcrumb' > </Iframe> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 5 additions & 1 deletion
6
website/docs/md_components/checkbox_components/showcase_markdown.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,17 @@ | ||
import Iframe from '../iframe_component.mdx'; | ||
|
||
## Default | ||
|
||
<Iframe id='components-forms-checkbox--default' > </Iframe> | ||
|
||
## Invalid | ||
|
||
<Iframe id='components-forms-checkbox--invalid' > </Iframe> | ||
|
||
## Optional | ||
|
||
<Iframe id='components-forms-checkbox--optional' > </Iframe> | ||
|
||
## Single | ||
<Iframe id='components-forms-checkbox--single' > </Iframe> | ||
|
||
<Iframe id='components-forms-checkbox--single' > </Iframe> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
website/docs/md_components/component_grid_components/api_markdown.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
## API | ||
|
||
<AccordionJSDoc /> | ||
|
||
## Setup | ||
|
||
There are 2 ways to initialise the component. | ||
|
||
### Automatic | ||
|
||
Add `data-ecl-auto-init="Accordion"` attribute to component's markup: | ||
|
||
```html | ||
<div class="ecl-accordion" data-ecl-accordion data-ecl-auto-init="Accordion"> | ||
... | ||
</div> | ||
``` | ||
|
||
Use the `ECL` library's `autoInit()` (`ECL.autoInit()`) when your page is ready or other custom event you want to hook onto. | ||
|
||
### Manual | ||
|
||
Get target element, create an instance and invoke `init()`. | ||
|
||
Given you have 1 element with an attribute `data-ecl-accordion` on the page: |
9 changes: 9 additions & 0 deletions
9
website/docs/md_components/component_grid_components/showcase_markdown.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
import Iframe from '../iframe_component.mdx'; | ||
|
||
## Default | ||
|
||
<Iframe id='layout-grid-component-grid--default' style="height:600px!important;" > </Iframe> | ||
|
||
## Example | ||
|
||
<Iframe id='layout-grid-component-grid--example' style="height:600px!important;" > </Iframe> |
38 changes: 38 additions & 0 deletions
38
website/docs/md_components/component_grid_components/usage_markdown.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: Grid | ||
--- | ||
|
||
## The grid: | ||
|
||
- containers are required when using our default grid system as they are the most basic layout elements, representing a means to horizontally align components or content elements - this is done by invoking `.ecl-container` | ||
- the column classes **express the number of columns to be engaged out of the maximum**, which is 12 per row (such as an element invoking `.ecl-col-2` occupies two columns) | ||
- **container widths and breakpoints are expressed in pixels** | ||
- each column has **horizontal padding (gutter) for regulating the space between** them | ||
- **the gutters are expressed in rems** | ||
- **the width of the columns is always proportional to the container width**, which is fixed (except for viewports <480px), and they are expressed in percentages | ||
- the rows wrap around the columns, allowing you to specify the amount of columns content wraps around | ||
|
||
## ECL Grid Options | ||
|
||
The grid's breakpoints are established on the minimum width media queries, therefore the are applied on the targeted breakpoint and all those above it. | ||
|
||
| viewport | Extra small (≥ 0px) | Small (≥ 480px) | Medium (≥ 768px) | Large (≥ 996px) | Extra large (≥ 1140px) | | ||
| --------------- | ------------------- | --------------- | ---------------- | --------------- | ---------------------- | | ||
| container width | 100% | 480px | 768px | 996px | 1140px | | ||
| class prefix | `.ecl-col-` | `.ecl-col-s-` | `.ecl-col-m-` | `.ecl-col-l-` | `.ecl-col-xl-` | | ||
|
||
## ECL Grid Examples | ||
|
||
## Grid offset | ||
|
||
When using the ECL grid, there is the ability to offset columns. You can offset columns from left to right by invoking the `.ecl-offset-*` classes (where \* = the number of columns). These classes simply increase the left margin by \* number of columns. | ||
|
||
## Do's | ||
|
||
- always place content within columns | ||
- specify the exact amount of columns content must occupy | ||
- use **`.ecl-offset-*` grid classes** for **offsetting content** | ||
|
||
## Don'ts | ||
|
||
- don't use margin to offset content |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
website/docs/md_components/dropdown_components/showcase_markdown.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
import Iframe from '../iframe_component.mdx'; | ||
|
||
## Default | ||
<Iframe id='components-forms-dropdown--default' > </Iframe> | ||
|
||
<Iframe id='components-forms-dropdown--default' > </Iframe> |
Oops, something went wrong.