/
NcEmptyContent.vue
211 lines (186 loc) · 4.04 KB
/
NcEmptyContent.vue
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<!--
- @copyright Copyright (c) 2020 Greta Doci <gretadoci@gmail.com>
-
- @author 2020 Greta Doci <gretadoci@gmail.com>
-
- @license GNU AGPL version 3 or any later version
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as
- published by the Free Software Foundation, either version 3 of the
- License, or (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-->
<docs>
### Basic use
Use this component to display a message about an empty content.
Providing an icon, title, and a description is strongly advised.
```
<template>
<NcEmptyContent
title="No comments">
<template #icon>
<Comment />
</template>
</NcEmptyContent>
</template>
<script>
import Comment from 'vue-material-design-icons/Comment'
export default {
components: {
Comment,
},
}
</script>
```
You can also customize the title using the `#title` slot
and add actions.
```
<template>
<NcEmptyContent
description="No comments in here">
<template #icon>
<Comment />
</template>
<template #title>
<h1 class="empty-content__title">
No Comments
</h1>
</template>
<template #action>
<NcButton type="primary">
Add a comment!
</NcButton>
</template>
</NcEmptyContent>
</template>
<script>
import Comment from 'vue-material-design-icons/Comment'
export default {
components: {
Comment,
},
}
</script>
```
Similar to the `#title` slot, you could also use the `#description` slot.
The content will be rendered within a paragraph so you can use any inline element,
like a link.
```
<template>
<NcEmptyContent
title="No comments">
<template #icon>
<Comment />
</template>
<template #description>
<a href="https://en.wikipedia.org/wiki/Comment">What is even a comment?</a>
</template>
</NcEmptyContent>
</template>
<script>
import Comment from 'vue-material-design-icons/Comment'
export default {
components: {
Comment,
},
}
</script>
```
</docs>
<template>
<div class="empty-content" role="note">
<div v-if="$slots.icon" class="empty-content__icon" aria-hidden="true">
<!-- @slot Optional material design icon -->
<slot name="icon" />
</div>
<slot name="title">
<h2 v-if="hasTitle" class="empty-content__title">
{{ title }}
</h2>
</slot>
<p v-if="hasDescription">
<!-- @slot Optional formatted description rendered inside a paragraph -->
<slot name="description">
{{ description }}
</slot>
</p>
<div v-if="$slots.action" class="empty-content__action">
<!-- @slot Optional slot for a button or the like -->
<slot name="action" />
</div>
</div>
</template>
<script>
export default {
name: 'NcEmptyContent',
props: {
title: {
type: String,
default: '',
},
description: {
type: String,
default: '',
},
},
computed: {
hasTitle() {
return this.title !== ''
},
/**
* Check if a description is given as either property or slot
*/
hasDescription() {
return this.description !== '' || this.$slots.description?.[0]
},
},
}
</script>
<style lang="scss" scoped>
.empty-content {
display: flex;
align-items: center;
flex-direction: column;
margin-top: 20vh;
.modal-wrapper & {
margin-top: 5vh;
margin-bottom: 5vh;
}
&__icon {
display: flex;
align-items: center;
justify-content: center;
width: 64px;
height: 64px;
margin: 0 auto 15px;
opacity: .4;
background-repeat: no-repeat;
background-position: center;
background-size: 64px;
:deep(svg) {
width: 64px;
height: 64px;
}
}
&__title {
margin-bottom: 10px;
text-align: center;
}
&__action {
margin-top: 8px;
.modal-wrapper & {
margin-top: 20px;
display: flex;
}
}
}
</style>