Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Container component #37

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions components/content/examples/container/ContainerCenter.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<template>
<c-container maxW='2xl' bg='blue.600' centerContent>
<c-box padding='4' bg='blue.400' color='black' maxW='md'>
There are many benefits to a joint design and development system. Not only
does it bring benefits to the design team, but it also brings benefits to
engineering teams. It makes sure that our experiences have a consistent look
and feel, not just in our design specs, but in production.
</c-box>
</c-container>
</template>

<script setup>
import { CContainer, CBox } from '@chakra-ui/vue-next';
</script>
17 changes: 17 additions & 0 deletions components/content/examples/container/ContainerSize.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<template>
<c-v-stack w="2xl" align-items="center">
<c-container maxW='md' bg='blue.600' color='white'>
"md" Container
</c-container>
<c-container maxW='550px' bg='purple.600' color='white'>
"550px" Container
</c-container>
<c-container maxW='container.sm' bg='green.400' color='#262626'>
"container.sm" Container
</c-container>
</c-v-stack>
</template>

<script setup>
import { CContainer, CVStack } from '@chakra-ui/vue-next';
</script>
12 changes: 12 additions & 0 deletions components/content/examples/container/SimpleContainer.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<template>
<c-container>
There are many benefits to a joint design and development system. Not only
does it bring benefits to the design team, but it also brings benefits to
engineering teams. It makes sure that our experiences have a consistent look
and feel, not just in our design specs, but in production
</c-container>
</template>

<script setup>
import { CContainer } from '@chakra-ui/vue-next';
</script>
78 changes: 78 additions & 0 deletions content/4.components/container.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
title: Container
description:
Container component is used to constrain a content's width to the current breakpoint, while keeping it fluid.
version: 2.0+
---

# Container

Containers are used to constrain a content's width to the current breakpoint, while keeping it fluid.

## Import

```js
import { CContainer } from '@chakra-ui/vue-next'
```

## Usage

To contain any piece of content, wrap it in the `Container` component.

::showcase
::simple-container
::
::

```html
<c-container>
There are many benefits to a joint design and development system. Not only
does it bring benefits to the design team, but it also brings benefits to
engineering teams. It makes sure that our experiences have a consistent look
and feel, not just in our design specs, but in production
</c-container>
```

### Container Size

By default, the `Container` component sets the `maxWidth` of the content to 60 characters (`60ch`) but you can customize this by passing custom `maxWidth` values or changing the size tokens.
D-Lite marked this conversation as resolved.
Show resolved Hide resolved

> * About the default value: The `ch` unit is a relative unit defined by the rendered typeface's "0" character width. This width varies by the shape and style of the font.
> * If you are curious about the reason for this default value of `60` characters, consider this explanation about [line length](https://betterwebtype.com/articles/2019/06/16/5-keys-to-accessible-web-typography/#line-length) from Better Web Type.

::showcase
::container-size
::
::

```html
<c-v-stack w="2xl" align-items="center">
<c-container maxW='md' bg='blue.600' color='white'>
D-Lite marked this conversation as resolved.
Show resolved Hide resolved
"md" Container
</c-container>
<c-container maxW='550px' bg='purple.600' color='white'>
D-Lite marked this conversation as resolved.
Show resolved Hide resolved
"550px" Container
</c-container>
<c-container maxW='container.sm' bg='green.400' color='#262626'>
D-Lite marked this conversation as resolved.
Show resolved Hide resolved
"container.sm" Container
</c-container>
</c-v-stack>
```

### Centering the children

In some cases, the width of the content can be smaller than the container's width. You can use the `centerContent` prop to center the content. It renders a flexbox with `flexDirection` set to `column` and `alignItems` set to `center`.
D-Lite marked this conversation as resolved.
Show resolved Hide resolved
::showcase
::container-center
::

```html
<c-container maxW='2xl' bg='blue.600' centerContent>
D-Lite marked this conversation as resolved.
Show resolved Hide resolved
<c-box padding='4' bg='blue.400' color='black' maxW='md'>
D-Lite marked this conversation as resolved.
Show resolved Hide resolved
There are many benefits to a joint design and development system. Not only
does it bring benefits to the design team, but it also brings benefits to
engineering teams. It makes sure that our experiences have a consistent look
and feel, not just in our design specs, but in production.
</c-box>
</c-container>
```