Skip to content
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

BREAKING CHANGE: Change umd exported name to VueCompositionAPI #399

Merged
merged 4 commits into from
Jun 23, 2020
Merged

BREAKING CHANGE: Change umd exported name to VueCompositionAPI #399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e619bb0
BREAKING CHANGE: rename umd exported name to `VueCompositionAPI`
antfu Jun 22, 2020
971f373
fix: typo
antfu Jun 22, 2020
dbc296e
Merge branch 'rc'
antfu Jun 22, 2020
6bef632
Merge branch 'rc' into refactor/change-umd-name
antfu Jun 23, 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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ You must install `@vue/composition-api` as a plugin via `Vue.use()` before you c

```js
import Vue from 'vue'
import VueCompositionApi from '@vue/composition-api'
import VueCompositionAPI from '@vue/composition-api'

Vue.use(VueCompositionApi)
Vue.use(VueCompositionAPI)
```

```js
Expand All @@ -44,7 +44,7 @@ Include `@vue/composition-api` after Vue and it will install itself automaticall
```
<!--cdn-links-end-->

`@vue/composition-api` will be exposed to global variable `window.vueCompositionApi`.
`@vue/composition-api` will be exposed to global variable `window.VueCompositionAPI`.

```ts
const { ref, reactive } = vueCompositionApi
Expand Down
10 changes: 5 additions & 5 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ yarn add @vue/composition-api
```
<!--cdn-links-end-->

通过全局变量 `window.vueCompositionApi` 来使用。
通过全局变量 `window.VueCompositionAPI` 来使用。

# 使用

在使用任何 `@vue/composition-api` 提供的能力前，必须先通过 `Vue.use()` 进行安装:

```js
import Vue from 'vue';
import VueCompositionApi from '@vue/composition-api';
import VueCompositionAPI from '@vue/composition-api';

Vue.use(VueCompositionApi);
Vue.use(VueCompositionAPI);
```

安装插件后，您就可以使用新的 [Composition API](https://vue-composition-api-rfc.netlify.com/) 来开发组件了。
Expand Down Expand Up @@ -294,9 +294,9 @@ export default {

```ts
import Vue from 'vue';
import VueCompositionApi from '@vue/composition-api';
import VueCompositionAPI from '@vue/composition-api';

Vue.use(VueCompositionApi);
Vue.use(VueCompositionAPI);

declare module '@vue/composition-api/dist/component/component' {
interface SetupContext {
Expand Down
2 changes: 1 addition & 1 deletion rollup.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ function genConfig({ outFile, format, mode }) {
vue: 'Vue',
},
exports: 'named',
name: format === 'umd' ? 'vueCompositionApi' : undefined,
name: format === 'umd' ? 'VueCompositionAPI' : undefined,
},
external: ['vue'],
onwarn,
Expand Down