mirror of
https://github.com/nuxt/nuxt.git
synced 2025-01-30 15:22:39 +00:00
docs: improve cookies section (#2092)
This commit is contained in:
parent
5be2f17b99
commit
5bc9012eff
@ -1,26 +1,26 @@
|
|||||||
# Cookies
|
# Cookies
|
||||||
|
|
||||||
> Nuxt provides SSR-friendly composable to read and write cookies.
|
Nuxt provides an SSR-friendly composable to read and write cookies.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Within your pages, components, and plugins you can use `useCookie` to create a reactive reference bound to a specific cookie.
|
Within your pages, components and plugins you can use `useCookie` to create a reactive reference bound to a specific cookie.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const cookie = useCookie(name, options)
|
const cookie = useCookie(name, options)
|
||||||
```
|
```
|
||||||
|
|
||||||
::alert{icon=👉}
|
::alert{icon=👉}
|
||||||
**`useCookie` only works during `setup` or `Lifecycle Hooks`**
|
**`useCookie` only works during `setup` or `Lifecycle Hooks`**.
|
||||||
::
|
::
|
||||||
|
|
||||||
::alert{icon=😌}
|
::alert{icon=😌}
|
||||||
`useCookie` ref will be automatically serialize and deserialized cookie value to JSON.
|
`useCookie` ref will automatically serialize and deserialize cookie value to JSON.
|
||||||
::
|
::
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
The example below creates a cookie called counter and if it doesn't exist set a random value. Whenever we update `counter`, the cookie will be updated.
|
The example below creates a cookie called `counter`. If the cookie doesn't exist, it is initially set to a random value. Whenever we update the `counter` variable, the cookie will be updated accordingly.
|
||||||
|
|
||||||
```vue
|
```vue
|
||||||
<template>
|
<template>
|
||||||
@ -48,9 +48,9 @@ counter.value = counter.value || Math.round(Math.random() * 1000)
|
|||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
Cookie composable accepts these properties in the options. Use them to modify the behavior of cookies.
|
Cookie composable accepts several options which let you modify the behavior of cookies.
|
||||||
|
|
||||||
Most of the options will be directly passed to [cookie](https://github.com/jshttp/cookie) package.
|
Most of the options will be directly passed to the [cookie](https://github.com/jshttp/cookie) package.
|
||||||
|
|
||||||
### `maxAge` / `expires`
|
### `maxAge` / `expires`
|
||||||
|
|
||||||
@ -58,43 +58,43 @@ Most of the options will be directly passed to [cookie](https://github.com/jshtt
|
|||||||
The given number will be converted to an integer by rounding down. By default, no maximum age is set.
|
The given number will be converted to an integer by rounding down. By default, no maximum age is set.
|
||||||
|
|
||||||
**`expires`**: Specifies the `Date` object to be the value for the [`Expires` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.1).
|
**`expires`**: Specifies the `Date` object to be the value for the [`Expires` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.1).
|
||||||
By default, no expiration is set, and most clients will consider this a "non-persistent cookie" and
|
By default, no expiration is set. Most clients will consider this a "non-persistent cookie" and
|
||||||
will delete it on a condition like exiting a web browser application.
|
will delete it on a condition like exiting a web browser application.
|
||||||
|
|
||||||
::alert{icon=💡}
|
::alert{icon=💡}
|
||||||
**Note:** The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and
|
**Note:** The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and
|
||||||
`maxAge` are set, then `maxAge` takes precedence, but it is possible not all clients obey this,
|
`maxAge` is set, then `maxAge` takes precedence, but not all clients may obey this,
|
||||||
so if both are set, they should point to the same date and time.eaks!
|
so if both are set, they should point to the same date and time!
|
||||||
::
|
::
|
||||||
|
|
||||||
::alert
|
::alert
|
||||||
If neither of `expires` and `maxAge` are set, cookie will be session-only and removed if the user closes their browser.
|
If neither of `expires` and `maxAge` is set, the cookie will be session-only and removed when the user closes their browser.
|
||||||
::
|
::
|
||||||
|
|
||||||
#### `httpOnly`
|
#### `httpOnly`
|
||||||
|
|
||||||
Specifies the `boolean` value for the [`HttpOnly` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.6). When truthy,
|
Specifies the `boolean` value for the [`HttpOnly` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.6). When truthy,
|
||||||
the `HttpOnly` attribute is set, otherwise, it is not. By default, the `HttpOnly` attribute is not set.
|
the `HttpOnly` attribute is set; otherwise it is not. By default, the `HttpOnly` attribute is not set.
|
||||||
|
|
||||||
::alert{icon=💡}
|
::alert{icon=💡}
|
||||||
**Note** be careful when setting this to `true`, as compliant clients will not allow client-side
|
**Note:** Be careful when setting this to `true`, as compliant clients will not allow client-side
|
||||||
JavaScript to see the cookie in `document.cookie`.
|
JavaScript to see the cookie in `document.cookie`.
|
||||||
::
|
::
|
||||||
|
|
||||||
#### `secure`
|
#### `secure`
|
||||||
|
|
||||||
Specifies the `boolean` value for the [`Secure` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.5). When truthy,
|
Specifies the `boolean` value for the [`Secure` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.5). When truthy,
|
||||||
the `Secure` attribute is set, otherwise,it is not. By default, the `Secure` attribute is not set.
|
the `Secure` attribute is set; otherwise it is not. By default, the `Secure` attribute is not set.
|
||||||
|
|
||||||
::alert{icon=💡}
|
::alert{icon=💡}
|
||||||
**Note:** be careful when setting this to `true`, as compliant clients will not send the cookie back to
|
**Note:** Be careful when setting this to `true`, as compliant clients will not send the cookie back to
|
||||||
the server in the future if the browser does not have an HTTPS connection. This can lead to hydration errors.
|
the server in the future if the browser does not have an HTTPS connection. This can lead to hydration errors.
|
||||||
::
|
::
|
||||||
|
|
||||||
#### `domain`
|
#### `domain`
|
||||||
|
|
||||||
Specifies the value for the [`Domain` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.3). By default, no
|
Specifies the value for the [`Domain` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.3). By default, no
|
||||||
domain is set, and most clients will consider the cookie to apply to only the current domain.
|
domain is set, and most clients will consider to apply the cookie only to the current domain.
|
||||||
|
|
||||||
#### `path`
|
#### `path`
|
||||||
|
|
||||||
@ -103,19 +103,19 @@ is considered the ["default path"](https://tools.ietf.org/html/rfc6265#section-5
|
|||||||
|
|
||||||
#### `sameSite`
|
#### `sameSite`
|
||||||
|
|
||||||
Specifies the `boolean` or `string` to be the value for the [`SameSite` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7).
|
Specifies the `boolean` or `string` value for the [`SameSite` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7).
|
||||||
|
|
||||||
- `true` will set the `SameSite` attribute to `Strict` for strict same site enforcement.
|
- `true` will set the `SameSite` attribute to `Strict` for strict same-site enforcement.
|
||||||
- `false` will not set the `SameSite` attribute.
|
- `false` will not set the `SameSite` attribute.
|
||||||
- `'lax'` will set the `SameSite` attribute to `Lax` for lax same site enforcement.
|
- `'lax'` will set the `SameSite` attribute to `Lax` for lax same-site enforcement.
|
||||||
- `'none'` will set the `SameSite` attribute to `None` for an explicit cross-site cookie.
|
- `'none'` will set the `SameSite` attribute to `None` for an explicit cross-site cookie.
|
||||||
- `'strict'` will set the `SameSite` attribute to `Strict` for strict same site enforcement.
|
- `'strict'` will set the `SameSite` attribute to `Strict` for strict same-site enforcement.
|
||||||
|
|
||||||
More information about the different enforcement levels can be found in [the specification](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7).
|
More information about the different enforcement levels can be found in [the specification](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7).
|
||||||
|
|
||||||
#### `encode`
|
#### `encode`
|
||||||
|
|
||||||
Specifies a function that will be used to encode a cookie's value. Since value of a cookie
|
Specifies a function that will be used to encode a cookie's value. Since the value of a cookie
|
||||||
has a limited character set (and must be a simple string), this function can be used to encode
|
has a limited character set (and must be a simple string), this function can be used to encode
|
||||||
a value into a string suited for a cookie's value.
|
a value into a string suited for a cookie's value.
|
||||||
|
|
||||||
@ -125,12 +125,12 @@ The default encoder is the `JSON.stringify` + `encodeURIComponent`.
|
|||||||
|
|
||||||
Specifies a function that will be used to decode a cookie's value. Since the value of a cookie
|
Specifies a function that will be used to decode a cookie's value. Since the value of a cookie
|
||||||
has a limited character set (and must be a simple string), this function can be used to decode
|
has a limited character set (and must be a simple string), this function can be used to decode
|
||||||
a previously-encoded cookie value into a JavaScript string or other object.
|
a previously encoded cookie value into a JavaScript string or other object.
|
||||||
|
|
||||||
The default decoder is `decodeURIComponent` + [destr](https://github.com/unjs/destr).
|
The default decoder is `decodeURIComponent` + [destr](https://github.com/unjs/destr).
|
||||||
|
|
||||||
::alert{icon=💡}
|
::alert{icon=💡}
|
||||||
**Note** if an error is thrown from this function, the original, non-decoded cookie value will
|
**Note:** If an error is thrown from this function, the original, non-decoded cookie value will
|
||||||
be returned as the cookie's value.
|
be returned as the cookie's value.
|
||||||
::
|
::
|
||||||
|
|
||||||
@ -144,7 +144,7 @@ You can use `useCookie` and `setCookie` from [`h3`](https://github.com/unjs/h3)
|
|||||||
import { useCookie, setCookie } from 'h3'
|
import { useCookie, setCookie } from 'h3'
|
||||||
|
|
||||||
export default (req, res) => {
|
export default (req, res) => {
|
||||||
// Reat counter cookie
|
// Read counter cookie
|
||||||
let counter = useCookie(req, 'counter') || 0
|
let counter = useCookie(req, 'counter') || 0
|
||||||
|
|
||||||
// Increase counter cookie by 1
|
// Increase counter cookie by 1
|
||||||
|
@ -16,7 +16,7 @@ const logout = () => {
|
|||||||
<div v-if="user">
|
<div v-if="user">
|
||||||
<h1>Welcome {{ user.name }}</h1>
|
<h1>Welcome {{ user.name }}</h1>
|
||||||
<button @click="logout">
|
<button @click="logout">
|
||||||
logout
|
Logout
|
||||||
</button>
|
</button>
|
||||||
<hr>
|
<hr>
|
||||||
You have logged in {{ logins }} times!
|
You have logged in {{ logins }} times!
|
||||||
|
Loading…
Reference in New Issue
Block a user