Skip to content

Options API Reference #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
May 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
eb63bde
feat: started with Global Config API
NataliaTepluhina Apr 19, 2020
af57779
feat: finished global config
NataliaTepluhina Apr 19, 2020
541ca7b
feat: added component global api
NataliaTepluhina Apr 25, 2020
e443c43
feat: added directives API
NataliaTepluhina Apr 25, 2020
7cd0651
feat: added mixin API
NataliaTepluhina Apr 25, 2020
5d9ee8c
feat: add mount API
NataliaTepluhina Apr 25, 2020
d55decb
feat: added unmount and use
NataliaTepluhina Apr 25, 2020
a98d5e2
Merge branch 'master' into api-reference
NataliaTepluhina Apr 25, 2020
e64ebf0
Update src/api/global-api.md
NataliaTepluhina Apr 26, 2020
49ffe23
Update src/api/global-config.md
NataliaTepluhina Apr 26, 2020
c4f9dd5
fixL changed global -> application
NataliaTepluhina Apr 26, 2020
ade37d0
Merge branch 'api-reference' of github.com:vuejs/docs-next into api-r…
NataliaTepluhina Apr 26, 2020
828972c
fix: fixed types for config
NataliaTepluhina Apr 26, 2020
1887ca5
fix: fixed types for API
NataliaTepluhina Apr 26, 2020
dfa977f
feat: added a note about native HTML tags
NataliaTepluhina Apr 26, 2020
cb6eb44
feat: added options data chapter
NataliaTepluhina Apr 26, 2020
aef68b0
feat: finished options data
NataliaTepluhina Apr 26, 2020
aeefc99
Merge branch 'master' into options-api
NataliaTepluhina Apr 30, 2020
d3d0d25
feat: added options-DOM
NataliaTepluhina Apr 30, 2020
98572f9
Added emits to data
NataliaTepluhina May 1, 2020
a69868d
feat: added lifecycle hooks
NataliaTepluhina May 1, 2020
050fae0
feat: added renderTracked and renderTriggered
NataliaTepluhina May 2, 2020
7bd1d81
feat: added options assets
NataliaTepluhina May 2, 2020
20b9627
feat: added options composition
NataliaTepluhina May 2, 2020
4a2f1e4
feat: added misc to options
NataliaTepluhina May 2, 2020
a800329
fix: TODO cleanup
NataliaTepluhina May 2, 2020
3b72dec
fix: changed data description
NataliaTepluhina May 3, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions src/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,22 @@ const sidebar = {
children: ['writing-guide']
}
],
api: ['/api/application-config', '/api/application-api']
api: [
'/api/application-config',
'/api/application-api',
{
title: 'Options',
collapsable: false,
children: [
'/api/options-data',
'/api/options-dom',
'/api/options-lifecycle-hooks',
'/api/options-assets',
'/api/options-composition',
'/api/options-misc'
]
}
]
}

module.exports = {
Expand All @@ -65,22 +80,22 @@ module.exports = {
'link',
{
href: 'https://use.fontawesome.com/releases/v5.13.0/css/all.css',
rel: 'stylesheet',
},
rel: 'stylesheet'
}
],
['link', { rel: 'icon', href: '/logo.png' }],
[
'script',
{
src: 'https://player.vimeo.com/api/player.js',
},
src: 'https://player.vimeo.com/api/player.js'
}
],
[
'script',
{
src: 'https://extend.vimeocdn.com/ga/72160148.js',
defer: 'defer',
},
defer: 'defer'
}
]
],
themeConfig: {
Expand Down
2 changes: 1 addition & 1 deletion src/api/application-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ app.mount('#my-app')

- **Details:**

This option is used together with [`inject`](TODO:inject) are used together to allow an ancestor component to serve as a dependency injector for all its descendants, regardless of how deep the component hierarchy is, as long as they are in the same parent chain.
This option is [used together with `inject`](../api/options-composition.html#provide-inject) to allow an ancestor component to serve as a dependency injector for all its descendants, regardless of how deep the component hierarchy is, as long as they are in the same parent chain.

The `provide` option should be an object or a function that returns an object. This object contains the properties that are available for injection into its descendants. You can use ES2015 Symbols as keys in this object, but only in environments that natively support `Symbol` and `Reflect.ownKeys`.

Expand Down
21 changes: 21 additions & 0 deletions src/api/options-assets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Assets

## directives

- **Type:** `Object`

- **Details:**

A hash of directives to be made available to the Vue instance.

- **See also:** [Custom Directives](../guide/custom-directive.html)

## components

- **Type:** `Object`

- **Details:**

A hash of components to be made available to the Vue instance.

- **See also:** [Components](../guide/component-basics.html)
Loading