Skip to content

docs(box): add box documentation #34

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs(box): add box documentation #34

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
80ce89d
docs(box): add box documentation
D-Lite May 30, 2023
53344c2
chore: resolve code review
D-Lite Jun 1, 2023
47e2b16
refactor: change name casing box
D-Lite Jul 7, 2023
180852e
refactor: change name casing box
D-Lite Jul 14, 2023
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
50 changes: 50 additions & 0 deletions components/content/examples/box/AirBnbBox.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<template>
<c-box maxW="sm" border-width="1px" rounded="lg" overflow="hidden">
<c-image :src="property.imageUrl" :alt="property.imageAlt" />
<c-box p="6">
<c-box d="flex" align-items="baseline">
<c-badge rounded="full" px="2" variant-color="green">
New
</c-badge>
<c-box color="gray.500" font-weight="semibold" letter-spacing="wide" font-size="xs" text-transform="uppercase"
ml="2">
{{ property.beds }} beds &bull; {{ property.baths }} baths
</c-box>
</c-box>
<c-box mt="1" font-weight="semibold" as="h4" line-height="tight" is-truncated>
{{ property.title }}
</c-box>
<c-box>
{{ property.formattedPrice }}
<c-box as="span" color="gray.600" fontSize="sm">
/ wk
</c-box>
</c-box>
<c-box d="flex" mt="2" align-items="center">
<c-icon v-for="(_, i) in Array(5).fill('')" name="star" :key="i"
:color="i < property.rating ? 'green.500' : 'gray.300'" />
<c-box as="span" ml="2" color="gray.600" font-size="sm">
{{ property.reviewCount }} reviews
</c-box>
</c-box>
</c-box>
</c-box>
</template>

<script setup>
import { reactive } from 'vue'

const property = reactive(
{
imageUrl: "https://bit.ly/2Z4KKcF",
imageAlt: "Rear view of modern home with pool",
beds: 3,
baths: 2,
title: "Modern home in city center in the heart of historic Los Angeles",
formattedPrice: "$1,900.00",
reviewCount: 34,
rating: 4,
}
)

</script>
5 changes: 5 additions & 0 deletions components/content/examples/box/AsBox.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<template>
<c-box as="button" rounded="md" bg="tomato" color="white" px="4" h="8">
Button
</c-box>
</template>
11 changes: 11 additions & 0 deletions components/content/examples/box/SimpleBox.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<template>
<c-box bg="tomato" w="100%" p="4" color="white">
This is the Box
</c-box>
</template>

<script setup>
import {
CBox
} from "@chakra-ui/vue-next"
</script>
110 changes: 110 additions & 0 deletions content/4.components/box.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
title: Box
description: Box component
version: 2.0+
---
# Box

Box is the most abstract component on top of which all other `@chakra-ui/vue` components are built. By default, it renders a `div` element

## Import

Chakra UI Vue exports 5 accordion-related components.
```js
import { CBox } from "@chakra-ui/vue-next"
```

## Usage

The Box component is useful because it helps with three common use cases:
- Create responsive layouts with ease.
- Provide a shorthand way to pass styles via props (`bg` instead of `backgroundColor`).
- Compose new component and allow for override using the `as` prop.

::showcase
:simple-box
::


```html
<c-box bg="tomato" w="100%" p="4" color="white">
This is the Box
</c-box>
```

## Composition with `CBox`

::showcase
:air-bnb-box{width=full}
::

```html
<template>
<c-box maxW="sm" border-width="1px" rounded="lg" overflow="hidden">
<c-image :src="property.imageUrl" :alt="property.imageAlt" />
<c-box p="6">
<c-box d="flex" align-items="baseline">
<c-badge rounded="full" px="2" variant-color="green">
New
</c-badge>
<c-box color="gray.500" font-weight="semibold" letter-spacing="wide" font-size="xs" text-transform="uppercase"
ml="2">
{{ property.beds }} beds &bull; {{ property.baths }} baths
</c-box>
</c-box>
<c-box mt="1" font-weight="semibold" as="h4" line-height="tight" is-truncated>
{{ property.title }}
</c-box>
<c-box>
{{ property.formattedPrice }}
<c-box as="span" color="gray.600" fontSize="sm">
/ wk
</c-box>
</c-box>
<c-box d="flex" mt="2" align-items="center">
<c-icon v-for="(_, i) in Array(5).fill('')" name="star" :key="i"
:color="i < property.rating ? 'green.500' : 'gray.300'" />
<c-box as="span" ml="2" color="gray.600" font-size="sm">
{{ property.reviewCount }} reviews
</c-box>
</c-box>
</c-box>
</c-box>
</template>

<script setup>
import { reactive } from 'vue'

const property = reactive(
{
imageUrl: "https://bit.ly/2Z4KKcF",
imageAlt: "Rear view of modern home with pool",
beds: 3,
baths: 2,
title: "Modern home in city center in the heart of historic Los Angeles",
formattedPrice: "$1,900.00",
reviewCount: 34,
rating: 4,
}
)

</script>
```

## as prop

You can use the `as` prop to change the element render, just like styled-components.

::showcase
:as-box{width-full}
::

```html
<c-box as="button" rounded="md" bg="tomato" color="white" px="4" h="8">
Button
</c-box>
```

## Props

See all `CBox` props in the [Style props page](/styled-system/style-props)