diff options
Diffstat (limited to 'docs/guide/components/page.md')
-rw-r--r-- | docs/guide/components/page.md | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/docs/guide/components/page.md b/docs/guide/components/page.md deleted file mode 100644 index 83106e37..00000000 --- a/docs/guide/components/page.md +++ /dev/null @@ -1,67 +0,0 @@ -# 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.
\ No newline at end of file |