-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add contaienr site
- Loading branch information
Showing
4 changed files
with
131 additions
and
10 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
--- | ||
title: Container | ||
group: Layout | ||
caption: Component used to structure the content. | ||
--- | ||
|
||
The `<Container>` component is a CSS grid layout component in which you can wrap child components. This component should be used if you want to structure content or form components. It is also useful when you want to use a [`<Breakout>`](/components/breakout/). | ||
|
||
`<Container>` width is based on used font and is optimized for readability. You can use `header` or `content` as content type and set the `size` prop to `small`, `medium` or `large`. | ||
|
||
It is also possible to set the alignment for the `<Container>` itself and for its children. | ||
|
||
## Usage | ||
|
||
### Import | ||
|
||
To import the component you just have to use this code below. | ||
|
||
```tsx | ||
import { Container } from '@marigold/components'; | ||
``` | ||
|
||
### Props | ||
|
||
<PropsTable | ||
props={[ | ||
{ | ||
property: 'contentType', | ||
description: 'The content type of the container.', | ||
type: '"header" | "content"', | ||
default: '"content"', | ||
}, | ||
{ | ||
property: 'size', | ||
description: 'The size of the container.', | ||
type: '"small" | "medium" | "large"', | ||
default: '"medium"', | ||
}, | ||
{ | ||
property: 'align', | ||
description: 'Set alignment the content inside the container.', | ||
type: '"left" | "center" | "right"', | ||
default: '"left"', | ||
}, | ||
{ | ||
property: 'alignItems', | ||
description: 'Set alignment of the items inside the container.', | ||
type: '"left" | "center" | "right" | "none"', | ||
default: '"none"', | ||
}, | ||
]} | ||
/> | ||
|
||
## Examples | ||
|
||
### Container sizes | ||
|
||
In this example the `size` prop is set to small. You can also choose medium or large size. It sets the width of the content of the container. | ||
|
||
<ComponentDemo file="./small-container.demo.tsx" /> | ||
|
||
## Text Container | ||
|
||
In some cases, the width of the content can be smaller than the container's width. You can use the `align` prop to align the container left, center or right. The `alignItems` props allows you to align the children left, center or right. | ||
|
||
<ComponentDemo file="./full-container.demo.tsx" /> |
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 @@ | ||
import { Container, Headline, List, Text } from '@marigold/components'; | ||
|
||
export default () => ( | ||
<Container size="large" alignItems="left" align="center"> | ||
<Headline level="2">Star Wars - The Empire Strikes Back</Headline> | ||
<Text> | ||
It is a dark time for the Rebellion. Although the Death Star has been | ||
destroyed, Imperial troops have driven the Rebel forces from their hidden | ||
base and pursued them across the galaxy. Evading the dreaded Imperial | ||
Starfleet, a group of freedom fighters led by Luke Skywalker has | ||
established a new secret base on the remote ice world of Hoth. The evil | ||
lord Darth Vader, obsessed with finding young Skywalker, has dispatched | ||
thousands of remote probes into the far reaches of space.... | ||
</Text> | ||
<List> | ||
<List.Item>Luke</List.Item> | ||
<List.Item>Leia</List.Item> | ||
<List.Item>Han Solo</List.Item> | ||
<List.Item>Chewbacca</List.Item> | ||
<List.Item>R2D2</List.Item> | ||
<List.Item>C3PO</List.Item> | ||
<List.Item>Darth Vader</List.Item> | ||
</List> | ||
</Container> | ||
); |
16 changes: 16 additions & 0 deletions
16
docs/content/components/container/small-container.demo.tsx
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,16 @@ | ||
import { Container, Headline, Text } from '@marigold/components'; | ||
|
||
export default () => ( | ||
<> | ||
<Container contentType="header" size="small" align="center"> | ||
<Headline level="2">Star Wars - The Empire Strikes Back</Headline> | ||
</Container> | ||
<Container size="small" align="center"> | ||
<Text> | ||
It is a dark time for the Rebellion. Although the Death Star has been | ||
destroyed, Imperial troops have driven the Rebel forces from their | ||
hidden base and pursued them across the galaxy. | ||
</Text> | ||
</Container> | ||
</> | ||
); |
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
3f55daf
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
marigold-storybook – ./
marigold-latest.vercel.app
marigold-storybook-marigold.vercel.app
marigold-storybook-git-main-marigold.vercel.app
3f55daf
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
marigold-docs – ./
marigold-docs-marigold.vercel.app
marigold-docs.vercel.app
marigold-docs-git-main-marigold.vercel.app