This repository was archived by the owner on Sep 20, 2024. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +34
-0
lines changed Expand file tree Collapse file tree 2 files changed +34
-0
lines changed Original file line number Diff line number Diff line change @@ -55,6 +55,7 @@ function getSetupSidebar() {
55
55
{ text : 'Alert' , link : '/components/alert' } ,
56
56
{ text : 'Badge' , link : '/components/badge' } ,
57
57
{ text : 'Button' , link : '/components/button' } ,
58
+ { text : 'Code' , link : '/components/code' } ,
58
59
{ text : 'Icon' , link : '/components/icon' } ,
59
60
{ text : 'Spinner' , link : '/components/spinner' } ,
60
61
{ text : 'CSS reset' , link : '/components/css-reset' } ,
Original file line number Diff line number Diff line change
1
+ # Code
2
+
3
+ Code is a component used to display inline code. It is composed from the Box component with a font family of ` mono ` for displaying code.
4
+
5
+ ## Import
6
+
7
+ ``` js
8
+ import { CCode } from " @chakra-ui/vue-next"
9
+ ```
10
+
11
+ ## Usage
12
+ ``` vue
13
+ <c-code>hello world</c-code>
14
+ ```
15
+
16
+ ### Code Color
17
+
18
+ Pass the ` colorScheme ` prop to customize the color of the Badge. ` colorScheme ` can be any ** color key** that exists in ` theme.colors ` .
19
+
20
+ TODO: Link to theming page
21
+
22
+ ``` vue
23
+ <c-code>hello world, default</c-code>
24
+ <c-code color-scheme="green">hello world, green</c-code>
25
+ <c-code color-scheme="red">hello world, red</c-code>
26
+ <c-code color-scheme="purple">hello world, purple</c-code>
27
+ ```
28
+
29
+ ## Props
30
+
31
+ | Name | Type | Description | Default |
32
+ | :---: | :---: | :---: | :---: |
33
+ | ` colorScheme ` | ` string ` | Color Scheme to be applied| "cyan" | "gray" | "green" | "orange" | "pink" | "purple" | "red" | "teal" | "yellow" | "whiteAlpha" | "blackAlpha" | "linkedin" | "facebook" | "messenger" | "whatsapp" | "twitter" | "telegram"`| ` "gray" ` |
You can’t perform that action at this time.
0 commit comments