Skip to content

Commit 8abae53

Browse files
committed
Create documentation for hidden component
1 parent 1da923a commit 8abae53

File tree

1 file changed

+33
-5
lines changed

1 file changed

+33
-5
lines changed

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,23 +53,41 @@ An example of how to use the library:
5353

5454
```vue
5555
<template>
56-
<row container gutter="{12}">
57-
<column xs="{12}" md="{4}" lg="{3}">
56+
<row container :gutter="12">
57+
<column :xs="12" :md="{4}" :lg="3">
5858
xs=12 md=4 lg=3
5959
</column>
60-
<column xs="{12}" md="{4}" lg="{3}">
60+
<column :xs="12" :md="4" :lg="3">
6161
xs=12 md=4 lg=3
6262
</column>
63-
<column xs="{12}" md="{4}" lg="{3}">
63+
<column :xs="12" :md="4" :lg="3">
6464
xs=12 md=4 lg=3
6565
</column>
66-
<column xs="{12}" md="{4}" lg="{3}">
66+
<column :xs="{12}" :md="4" :lg="3">
6767
xs=12 md=4 lg=3
6868
</column>
6969
</row>
7070
</template>
7171
```
7272

73+
Using then hidden component:
74+
75+
```vue
76+
<template>
77+
<div>
78+
<hidden :xs="true">
79+
hidden xs
80+
</hidden>
81+
<hidden :md="true">
82+
hidden md
83+
</hidden>
84+
<hidden :xl="true">
85+
hidden xl
86+
</hidden>
87+
</div>
88+
</template>
89+
```
90+
7391
## Demo [Link](https://vue-grid-responsive.netlify.com/)
7492

7593
Local demo:
@@ -101,6 +119,16 @@ Component props:
101119
| lg | - | number | Size in large screen |
102120
| xl | - | number | Size in extra large screen |
103121

122+
### Hidden Component props
123+
124+
| Prop | Default | Type | Description |
125+
| ---- | ------- | ------- | -------------------------- |
126+
| xs | - | boolean | Hidden in extra small size |
127+
| sm | - | boolean | Hidden in small size |
128+
| md | - | boolean | Hidden in medium size |
129+
| lg | - | boolean | Hidden in large size |
130+
| xl | - | boolean | Hidden in extra large size |
131+
104132
## NPM Statistics
105133

106134
Download stats for this NPM package

0 commit comments

Comments
 (0)