Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
40a7291f
Commit
40a7291f
authored
Jul 29, 2021
by
Kushal Pandya
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add docs for dependency injection
parent
3102da30
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
64 additions
and
5 deletions
+64
-5
doc/development/fe_guide/vue.md
doc/development/fe_guide/vue.md
+64
-5
No files found.
doc/development/fe_guide/vue.md
View file @
40a7291f
...
@@ -66,12 +66,68 @@ To do that, you can use the `data` attributes in the HTML element and query them
...
@@ -66,12 +66,68 @@ To do that, you can use the `data` attributes in the HTML element and query them
You should only do this while initializing the application, because the mounted element is replaced
You should only do this while initializing the application, because the mounted element is replaced
with a Vue-generated DOM.
with a Vue-generated DOM.
The advantage of providing data from the DOM to the Vue instance through
`props`
in the
`render`
The advantage of providing data from the DOM to the Vue instance through
`props`
or
function instead of querying the DOM inside the main Vue component is avoiding the need to create a
`provide`
in the
`render`
function, instead of querying the DOM inside the main Vue
fixture or an HTML element in the unit test, which makes the tests easier
.
component, is that you avoid the need to create a fixture or an HTML element in the unit test
.
See the following example. Also, please refer to our
[
Vue style guide
](
style/vue.md#basic-rules
)
for
##### provide/inject
additional information on why we explicitly declare the data being passed into the Vue app;
Vue supports dependency injection through
[
provide/inject
](
https://vuejs.org/v2/api/#provide-inject
)
.
Values passed to the component through
`provide`
can be accessed in the component the
`inject`
configuration.
In the following example of a Vue app initialization, a value from HAML is passed to the component
through the
`provide`
configuration:
```
javascript
#
js
-
vue
-
app
{
data
:
{
endpoint
:
'
foo
'
}}
// index.js
const
el
=
document
.
getElementById
(
'
js-vue-app
'
);
if
(
!
el
)
return
false
;
const
{
endpoint
}
=
el
.
dataset
;
return
new
Vue
({
el
,
render
(
createElement
)
{
return
createElement
(
'
my-component
'
,
{
provide
:
{
endpoint
},
});
},
});
```
The component, or any of its child components, can access the property through
`inject`
as:
```
vue
<
script
>
export
default
{
name
:
'
MyComponent
'
,
inject
:
[
'
endpoint
'
],
...
...
};
</
script
>
<
template
>
...
...
</
template
>
```
Using dependency injection to provide values from HAML is ideal when:
-
The injected value doesn't need an explicit validation against its data type or contents.
-
The value doesn't need to be reactive.
-
There are multiple components in the hierarchy that need access to this value where
prop-drilling becomes an inconvenience. Prop-drilling when the same prop is passed
through all components in the hierarchy until the component that is genuinely using it.
##### props
If the value from HAML doesn't fit the criteria of dependency injection, use
`props`
.
See the following example.
```
javascript
```
javascript
// haml
// haml
...
@@ -99,6 +155,9 @@ return new Vue({
...
@@ -99,6 +155,9 @@ return new Vue({
> When adding an `id` attribute to mount a Vue application, please make sure this `id` is unique
> When adding an `id` attribute to mount a Vue application, please make sure this `id` is unique
across the codebase.
across the codebase.
For more information on why we explicitly declare the data being passed into the Vue app,
refer to our
[
Vue style guide
](
style/vue.md#basic-rules
)
.
#### Providing Rails form fields to Vue applications
#### Providing Rails form fields to Vue applications
When composing a form with Rails, the
`name`
,
`id`
, and
`value`
attributes of form inputs are generated
When composing a form with Rails, the
`name`
,
`id`
, and
`value`
attributes of form inputs are generated
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment