blob: 83106e37b692470971d91e2851301766e5b6cfba (
plain)
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
|
# Page
The essential building blocks of each page, or single-file component, consist of:
- `<b-container>`
- `<page-title>`
- `<page-section>`
```vue
<template>
<b-container fluid="xl">
<page-title />
<page-section :section-title="$t('pageName.sectionTitle')">
// Page content goes here
</page-section>
</b-container>
</template>
```
## Page container
Use the `fluid="xl"` prop on the `<b-container>` component to render a container that is always 100% width on larger screen sizes. [Learn more about BootstrapVue containers](https://bootstrap-vue.org/docs/components/layout#responsive-fluid-containers).
```vue
<template>
<b-container fluid="xl">
</b-container>
</template>
```
Within the page container, include the [page title](#/page-title) and [page section](#page-section) components.
## Page title
The `<page-title>` component will automatically render the page title that corresponds with the title property set in the route record's meta field in `src/router/routes.js`.
```js
// src/router/routes.js
{
path: '',
name: 'login',
component: Login,
meta: {
title: i18n.t('appPageTitle.login'),
},
},
```
Optional page descriptions can be included by using the description prop `:description` prop and passing in the i18n localized text string. Translations are found in the `src/locales` folder.
``` vue
// Example: `src/views/AccessControl/Ldap/Ldap.vue`
<page-title :description="$t('pageLdap.pageDescription')" />
```
[View the page title component source code](https://github.com/openbmc/webui-vue/blob/master/src/components/Global/PageTitle.vue).
## Page section
The `<page-section>` component will render semantic HTML. By adding a `:section-title` prop to the `<page-section>` component, the localized text string will be rendered in an `h2` header element.
``` vue
// Example: `src/views/AccessControl/Ldap/Ldap.vue`
<page-section :section-title="$t('pageLdap.settings')">
```
[View the page section component source code](https://github.com/openbmc/webui-vue/blob/master/src/components/Global/PageSection.vue).
[Visit the quick start guide](/guide/quickstart/page-anatomy) to learn how to build a single-file component using this page anatomy.
|
