Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vinicius73/vue-page-title
Vue.js html/page title manager
https://github.com/vinicius73/vue-page-title
document head html meta vue
Last synced: about 2 months ago
JSON representation
Vue.js html/page title manager
- Host: GitHub
- URL: https://github.com/vinicius73/vue-page-title
- Owner: vinicius73
- License: mit
- Created: 2018-06-23T19:07:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-15T00:01:15.000Z (11 months ago)
- Last Synced: 2024-07-22T00:27:48.336Z (2 months ago)
- Topics: document, head, html, meta, vue
- Language: Vue
- Homepage: https://vinicius73.github.io/vue-page-title/
- Size: 4.65 MB
- Stars: 128
- Watchers: 3
- Forks: 10
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-made-by-brazilians - Vue Page Title
README
# Vue Page Title
[](https://codeclimate.com/github/vinicius73/vue-page-title/maintainability) [](https://codeclimate.com/github/vinicius73/vue-page-title/test_coverage) [](https://scrutinizer-ci.com/g/vinicius73/vue-page-title/?branch=master) [](https://scrutinizer-ci.com/g/vinicius73/vue-page-title/build-status/master)
[](https://snyk.io/test/github/vinicius73/vue-page-title?targetFile=package.json) [](https://bundlephobia.com/result?p=vue-page-title) [](https://github.com/vinicius73/vue-page-title/actions/workflows/tests.yml)
[](https://vinicius73.github.io/vue-page-title/index.html) [](https://vinicius73.github.io/vue-page-title/types/index.html)
## Install [](https://badge.fury.io/js/vue-page-title)
```shell
yarn add vue-page-title # npm i vue-page-title
```
## Setup
```js
import { createApp } from 'vue';
import { pageTitle } from 'vue-page-title';
const app = createApp(Root);
app.use(
pageTitle({
suffix: '- Vue Page Title',
mixin: true,
})
);
```
#### Examples
- [mixin 01](https://jsfiddle.net/vinicius73/3b5nrkdu/)
- [mixin 02](https://jsfiddle.net/vinicius73/3tqknpLf/)
- [composition](https://jsfiddle.net/vinicius73/3fnpq2hL/)
### Compatibility
| Vue | Version |
| --- | ------------------------------------------------------------- |
| v2 | [v1.\*](https://github.com/vinicius73/vue-page-title/tree/v1) |
| v3 | [v2.\*](https://github.com/vinicius73/vue-page-title/) |
#### Migration from v1
All resources from `v1` works on `v2`.
Now mixin is optional and must be defined as true to be automatically registered in the app.
### Options
| Name | Type | Description |
| -------------- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
| suffix | `String` | suffix for the value of the page title tag |
| prefix | `String` | prefix for the value of the page title tag |
| separator | `String` | a string that comes between the prefix and the title / the title and the suffix, defaults to a space |
| mixin | `Boolean` | if true, enable plugin mixin in the components |
| router | [VueRouter instance](https://router.vuejs.org/api/#router-instance-properties) | if present, allows you to set the title via the route. |
| setTitleMethod | `Function` | custom method of setting title |
## Usage
### Composition API
```vue
import { createApp, h, ref, computed, onBeforeUnmount } from 'vue';
import { useTitle } from 'vue-page-title';
const CAPTAINS = [
'Monkey D. Luffy',
'Trafalgar D. Water Law',
'Eustass Kid',
'Shanks',
'Edward Newgate',
'Charlotte Linlin',
'Capone Bege',
'Gol D. Roger',
];
const getCapitain = () => CAPTAINS[Math.floor(Math.random() * CAPTAINS.length)];
export default defineComponent({
setup() {
const current = ref('Capitains');
const { title } = useTitle(current);
const refresh = () => {
current.value = getCapitain();
};
const interval = setInterval(refresh, 5000);
onBeforeUnmount(() => {
clearInterval(interval);
});
return {
title,
};
},
});
{{ title }}
```
```ts
const { title } = useTitle('initial title`)
```
#### React from ref state
```ts
const name = ref('initial name');
const { title } = useTitle(name);
```
#### Use like a watch source argument
```ts
const product = ref({ name: 'One Piece 1017' });
const { title } = useTitle(() => product.name);
```
#### Pass a computed as argument
```ts
const product = ref({ name: 'One Piece 1017' });
const name = computed(() => product.name);
const { title } = useTitle(name);
```
#### Use `setTitle` to dynamically change the title
```ts
const product = ref({ name: 'One Piece 1017' });
const { setTitle } = useTitle();
watchEffect(() => {
setTitle(product.name);
});
```
### Mixin
With the mixin option enabled, just set the `title` option inside the component.
Within the component it is still possible to update the `$title` state using `$setPageTitle` function, it is also available to be used within the component template.
> The option `mixin` must be `true`.
```vue
const CREW = [
'Monkey D. Luffy',
'Roronoa Zoro',
'Nami',
'Usopp',
'Sanji',
'Tony Tony Chopper',
'Nico Robin',
'Franky',
'Brook',
'Jinbe',
'Nefertari Vivi',
];
export default {
title: 'Mugiwara no Ichimi',
mounted() {
this.$interval = setInterval(() => {
this.$setPageTitle(CREW[Math.floor(Math.random() * CREW.length)]);
}, 2000);
},
beforeDestroy() {
clearInterval(this.$interval);
},
};
{{ $title }}
```
#### Function title
You are able to turn the title changes acative, like a computed.
```vue
const EMPERORS = ['Shanks', 'Marshall D. Teach', 'Monkey D. Luffy', 'Buggy'];
export default {
title() {
return `🏴☠️ ${this.emperor}`;
},
data() {
return {
emperor: 'Four Emperors',
};
},
mounted() {
this.$interval = setInterval(() => {
this.emperor = EMPERORS[Math.floor(Math.random() * EMPERORS.length)];
}, 2000);
},
beforeDestroy() {
clearInterval(this.$interval);
},
};
{{ $title }}
```
This is particularly useful for internationalization.
This is an example using [vue-i18n@9](https://github.com/intlify/vue-i18n-next).
```js
export default {
title: ({ $t }) => $t('pages.clients.title'),
};
```
## Vue Router integration
### Setup
```js
import { createApp } from 'vue';
import { pageTitle } from 'vue-page-title';
import router from 'path/to/application/router';
const app = createApp(Root);
app.use(pageTitle({ router }));
```
> path/to/application/router
```js
import { createRouter, createWebHashHistory } from 'vue-router';
import FooComponent from 'path/to/foo-component';
import HomeComponent from 'path/to/home-component';
const routes = [
{
path: '/',
component: HomeComponent,
meta: {
title: 'Home Page', // Title must be a string.
},
},
{
path: '/foo',
component: FooComponent,
meta: {
title: 'Foo Page',
},
},
];
export default createRouter({
history: createWebHashHistory(),
routes,
});
```
### Watching routes
```js
export default {
title() {
return `My title is: ${this.$route.query.foo}`;
},
};
```