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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 27 commits into from
May 4, 2020
Merged

Options API Reference #73

merged 27 commits into from
May 4, 2020

Conversation

NataliaTepluhina
Copy link
Member

@NataliaTepluhina NataliaTepluhina commented Apr 26, 2020 •
edited
Loading

This PR migrates an Options section of the API reference. In addition, I've done a little cleanup of TODOs

  • Data
  • DOM
  • Lifecycle hooks
  • Assets
  • Composition
  • Misc

NataliaTepluhina and others added 17 commits April 19, 2020 19:30
@NataliaTepluhina
feat: started with Global Config API
eb63bde
@NataliaTepluhina
feat: finished global config
af57779
@NataliaTepluhina
feat: added component global api
541ca7b
@NataliaTepluhina
feat: added directives API
e443c43
@NataliaTepluhina
feat: added mixin API
7cd0651
@NataliaTepluhina
feat: add mount API
5d9ee8c
@NataliaTepluhina
feat: added unmount and use
d55decb
@NataliaTepluhina
Merge branch 'master' into api-reference
a98d5e2
@NataliaTepluhina @Jinjiang
Update src/api/global-api.md
e64ebf0 
Co-Authored-By: Jinjiang <[email protected]>
@NataliaTepluhina @Jinjiang
Update src/api/global-config.md
49ffe23 
Co-Authored-By: Jinjiang <[email protected]>
@NataliaTepluhina
fixL changed global -> application
c4f9dd5
@NataliaTepluhina
Merge branch 'api-reference' of github.com:vuejs/docs-next into api-r…
ade37d0 
…eference
@NataliaTepluhina
fix: fixed types for config
828972c
@NataliaTepluhina
fix: fixed types for API
1887ca5
@NataliaTepluhina
feat: added a note about native HTML tags
dfa977f
@NataliaTepluhina
feat: added options data chapter
cb6eb44
@NataliaTepluhina
feat: finished options data
aef68b0
@NataliaTepluhina NataliaTepluhina added content Issues / PRs related to docs content enhancement New feature or request labels Apr 26, 2020
@NataliaTepluhina NataliaTepluhina added this to the alpha milestone Apr 26, 2020
@bencodezen bencodezen marked this pull request as draft April 27, 2020 03:09
@bencodezen
Copy link
Member

@NataliaTepluhina Saw that you marked it as WIP so I converted the PR to Draft so it didn't accidentally get merged before you are ready.

Missing GitLab's feature of detecting WIP and automatically doing this for me already. 😆

@NataliaTepluhina NataliaTepluhina changed the base branch from api-reference to master April 30, 2020 17:27
@NataliaTepluhina NataliaTepluhina changed the base branch from master to api-reference April 30, 2020 17:28
@NataliaTepluhina NataliaTepluhina changed the base branch from api-reference to master April 30, 2020 17:29
@NataliaTepluhina NataliaTepluhina marked this pull request as ready for review May 2, 2020 16:52
NataliaTepluhina
NataliaTepluhina commented May 2, 2020
View reviewed changes
src/api/options-composition.md

- **See also:** [Provide / Inject](../guide/component-provide-inject.html)

## setup
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still not sure whether setup belongs here or not. Technically, it's still a component option so it should be at least listed in Options but I am open for a discussion how detailed this description should be and what should we move to Composition API reference section

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be in both, ideally. The API definition tends to come up first in search, and setup is likely to be something folks are searching for to learn a lot right now. The Guide offers something above the API, because it tends to be more human-legible and friendly.

sdras
sdras approved these changes May 2, 2020
View reviewed changes
Copy link
Member

@sdras sdras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some small nits, but generally great job moving things over. Thanks for updating the todos along the way.

src/api/options-composition.md

- **See also:** [Provide / Inject](../guide/component-provide-inject.html)

## setup
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be in both, ideally. The API definition tends to come up first in search, and setup is likely to be something folks are searching for to learn a lot right now. The Guide offers something above the API, because it tends to be more human-legible and friendly.

@NataliaTepluhina NataliaTepluhina changed the title [WIP] Options API Options API Reference May 3, 2020
@NataliaTepluhina NataliaTepluhina merged commit 5509287 into master May 4, 2020
NataliaTepluhina added a commit that referenced this pull request May 4, 2020
@NataliaTepluhina
Squashed commit of the following:
b62c049 
commit 5509287
Author: Natalia Tepluhina <[email protected]>
Date:   Mon May 4 06:57:13 2020 +0300

    Options API Reference (#73)

    * feat: started with Global Config API

    * feat: finished global config

    * feat: added component global api

    * feat: added directives API

    * feat: added mixin API

    * feat: add mount API

    * feat: added unmount and use

    * Update src/api/global-api.md

    Co-Authored-By: Jinjiang <[email protected]>

    * Update src/api/global-config.md

    Co-Authored-By: Jinjiang <[email protected]>

    * fixL changed global -> application

    * fix: fixed types for config

    * fix: fixed types for API

    * feat: added a note about native HTML tags

    * feat: added options data chapter

    * feat: finished options data

    * feat: added options-DOM

    * Added emits to data

    * feat: added lifecycle hooks

    * feat: added renderTracked and renderTriggered

    * feat: added options assets

    * feat: added options composition

    * feat: added misc to options

    * fix: TODO cleanup

    * fix: changed data description

    Co-authored-by: Jinjiang <[email protected]>

commit b31cbfc
Author: Damian Dulisz <[email protected]>
Date:   Sun May 3 16:18:35 2020 +0200

    [Rough Draft] Composition-API: Introduction (#67)

    * Add Composition-API: Introduction draft

    * Fix image links

    * Add styling for Tips and Warnings. Fix missing `js` syntax flag

    * Apply suggestions from An Phan

    Co-Authored-By: Phan An <[email protected]>

    * Apply suggestions from code review

    Co-Authored-By: Phan An <[email protected]>
    Co-Authored-By: Rahul Kadyan <[email protected]>

    * Convert tabs to spaces

    Co-authored-by: Phan An <[email protected]>
    Co-authored-by: Rahul Kadyan <[email protected]>

commit 19c7285
Author: NataliaTepluhina <[email protected]>
Date:   Sun May 3 17:18:17 2020 +0300

    fix: fixed slots inconsistence
NataliaTepluhina added a commit that referenced this pull request May 4, 2020
@NataliaTepluhina @Jinjiang
Instance Properties API reference (#75)
3e36371 
* feat: started with Global Config API

* feat: finished global config

* feat: added component global api

* feat: added directives API

* feat: added mixin API

* feat: add mount API

* feat: added unmount and use

* Update src/api/global-api.md

Co-Authored-By: Jinjiang <[email protected]>

* Update src/api/global-config.md

Co-Authored-By: Jinjiang <[email protected]>

* fixL changed global -> application

* fix: fixed types for config

* fix: fixed types for API

* feat: added a note about native HTML tags

* feat: added options data chapter

* feat: finished options data

* feat: added options-DOM

* Added emits to data

* feat: added lifecycle hooks

* feat: added renderTracked and renderTriggered

* feat: added options assets

* feat: added options composition

* feat: added misc to options

* fix: TODO cleanup

* fix: changed data description

* Added instance properties

* Squashed commit of the following:

commit 5509287
Author: Natalia Tepluhina <[email protected]>
Date:   Mon May 4 06:57:13 2020 +0300

    Options API Reference (#73)

    * feat: started with Global Config API

    * feat: finished global config

    * feat: added component global api

    * feat: added directives API

    * feat: added mixin API

    * feat: add mount API

    * feat: added unmount and use

    * Update src/api/global-api.md

    Co-Authored-By: Jinjiang <[email protected]>

    * Update src/api/global-config.md

    Co-Authored-By: Jinjiang <[email protected]>

    * fixL changed global -> application

    * fix: fixed types for config

    * fix: fixed types for API

    * feat: added a note about native HTML tags

    * feat: added options data chapter

    * feat: finished options data

    * feat: added options-DOM

    * Added emits to data

    * feat: added lifecycle hooks

    * feat: added renderTracked and renderTriggered

    * feat: added options assets

    * feat: added options composition

    * feat: added misc to options

    * fix: TODO cleanup

    * fix: changed data description

    Co-authored-by: Jinjiang <[email protected]>

commit b31cbfc
Author: Damian Dulisz <[email protected]>
Date:   Sun May 3 16:18:35 2020 +0200

    [Rough Draft] Composition-API: Introduction (#67)

    * Add Composition-API: Introduction draft

    * Fix image links

    * Add styling for Tips and Warnings. Fix missing `js` syntax flag

    * Apply suggestions from An Phan

    Co-Authored-By: Phan An <[email protected]>

    * Apply suggestions from code review

    Co-Authored-By: Phan An <[email protected]>
    Co-Authored-By: Rahul Kadyan <[email protected]>

    * Convert tabs to spaces

    Co-authored-by: Phan An <[email protected]>
    Co-authored-by: Rahul Kadyan <[email protected]>

commit 19c7285
Author: NataliaTepluhina <[email protected]>
Date:   Sun May 3 17:18:17 2020 +0300

    fix: fixed slots inconsistence

* Revert "Squashed commit of the following:"

This reverts commit b62c049.

Co-authored-by: Jinjiang <[email protected]>
@NataliaTepluhina NataliaTepluhina deleted the options-api branch May 4, 2020 04:17
TalexDreamSoul pushed a commit to Talexs/docs that referenced this pull request Apr 17, 2022
@bfrontend
docs(reactivity-fundamentals.md): fix world error (vuejs#73)
bdb8777 
修复响应式基础中的文案错误
moHaHa pushed a commit to moHaHa/vuejs-docs that referenced this pull request May 4, 2023
@Abdelaziz18003
Merge pull request vuejs#73 from boussadjra/feat/custom-directives
a3541a3 
translate custom directives
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sdras sdras sdras approved these changes

@phanan phanan Awaiting requested review from phanan

@bencodezen bencodezen Awaiting requested review from bencodezen

@Jinjiang Jinjiang Awaiting requested review from Jinjiang

@shentao shentao Awaiting requested review from shentao

@znck znck Awaiting requested review from znck

Assignees
No one assigned
Labels
content Issues / PRs related to docs content enhancement New feature or request
Projects
None yet
Milestone
alpha
Development

Successfully merging this pull request may close these issues.
3 participants
@NataliaTepluhina @bencodezen @sdras