Skip to content

Commit 76377a9

Browse files
authoredDec 8, 2024··
Merge pull request #142 from hnviradiya/topic/documentation
English Documentation Typos fixed
2 parents 0e28a72 + 13c0a3b commit 76377a9

File tree

12 files changed

+17
-17
lines changed

12 files changed

+17
-17
lines changed
 

‎changelog/v3.0.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export default toNative(MyComp)
2626
export default class MyComp extends Vue{}
2727
```
2828

29-
### Deprecate init class property despends on another in constructor
29+
### Deprecate init class property depends on another in constructor
3030

3131
This is not allowed now.
3232
```typescript

‎changelog/v3.0.1.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
1. Use class constructor name as default component name.
44

5-
2. `@Ref` decorator accepts `key` paramater.
5+
2. `@Ref` decorator accepts `key` parameter.
66

77
3. New `@Provide` decorator
88

99
# Document Update
1010

11-
1. `@Ref`, which accepts `key` paramater.
11+
1. `@Ref`, which accepts `key` parameter.
1212

1313
2. New `@Provide` decorator

‎docs/en/class-component/accessor/accessor.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## Usage
22

3-
Property getters will be tranformed into `{computed:{get:Foo}}`.
3+
Property getters will be transformed into `{computed:{get:Foo}}`.
44

55
[](./code-usage.ts ':include :type=code typescript')
66

77
## Writable
88

9-
Property setters will be tranformed into `{computed:{set:Foo}}`.
9+
Property setters will be transformed into `{computed:{set:Foo}}`.
1010

1111
[](./code-writable.ts ':include :type=code typescript')
1212

‎docs/en/class-component/event/event.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
We could define a method which triggers a vue event by `Emit` decorator.
44

5-
The decorator received an optional event name paramater. Event will be triggered with this name and the method returned value. If the event name parameter is omitted, use method's name by default.
5+
The decorator received an optional event name parameter. Event will be triggered with this name and the method returned value. If the event name parameter is omitted, use method's name by default.
66

77
[](./code-usage.ts ':include :type=code typescript')
88

‎docs/en/class-component/hooks/hooks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Usage
22

3-
Class component supports almost all lifecycle hooks in vanilla vue. Write them as class methods directly. Hooks won't be tranformed into `methods`.
3+
Class component supports almost all lifecycle hooks in vanilla vue. Write them as class methods directly. Hooks won't be transformed into `methods`.
44

55
> All these hooks must be methods of a class, not properties.
66
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Usage
22

3-
Use the decorator `Setup` exported from `'vue-facing-decorator'` to inject [composables](https://vuejs.org/guide/reusability/composables.html) into your component's class as proeprty.
3+
Use the decorator `Setup` exported from `'vue-facing-decorator'` to inject [composables](https://vuejs.org/guide/reusability/composables.html) into your component's class as property.
44

55
[](./code-usage-base.ts ':include :type=code typescript')
66

‎docs/en/class-component/watcher/watcher.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Use `Watch` decorator to define a watcher in vue's `watch`.
44

55
The first parameter is the name watched.
66

7-
Same as vue `watch`, the watcher receives two paremeters: new value and old value.
7+
Same as vue `watch`, the watcher receives two parameters: new value and old value.
88

99
[](./code-usage.ts ':include :type=code typescript')
1010

‎docs/en/custom/custom.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Use `createDecorator` to build your own decorators.
44

5-
If you are a package author, install vue-facing-decorator as `devDependecies` and mark it in `peerDependencies`.
5+
If you are a package author, install vue-facing-decorator as `devDependencies` and mark it in `peerDependencies`.
66

77
`createDecorator` receives a creator function, which accepts two parameters:
88
1. Generated vue options component, you can modify it to implement anything you want.

‎docs/en/inheritance/complex-example/complex-example.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Consider code:
44

55
[](./code-example.ts ':include :type=code typescript')
66

7-
There are three components: `Comp`(includes `CompSper`), `SuperComp`(includes `SuperCompSuper`) and `VueNativeComponent`.
7+
There are three components: `Comp`(includes `CompSuper`), `SuperComp`(includes `SuperCompSuper`) and `VueNativeComponent`.
88

99
The inheritance relationship is:
1010

@@ -14,4 +14,4 @@ The inheritance relationship is:
1414
vue extends (SuperComp ECMAScript extends SuperCompSuper)
1515
```
1616

17-
Due to vue implemention, `VueNativeComponent`(useing vue `mixins`) will overwrite `SuperComp`(useing vue `extends`).
17+
Due to vue implementation, `VueNativeComponent`(using vue `mixins`) will overwrite `SuperComp`(using vue `extends`).

‎docs/en/migration/from-v2-to-v3.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To migrate from v2, you need to change your project with some break changes.
44

5-
In 3.x, decorator `Component` is same to `ComponentBase`, and you should cast class component to vue options API manually, see Breaking changes secion.
5+
In 3.x, decorator `Component` is same to `ComponentBase`, and you should cast class component to vue options API manually, see Breaking changes section.
66

77
## Breaking changes
88

@@ -12,7 +12,7 @@ It is recommended to use `toNative` to transform a class component into a vue op
1212

1313
[](./from-v2-to-v3-breaking-changes-toNative.ts ':include :type=code typescript')
1414

15-
### Depreactate init class property despends on another in constructor
15+
### Deprecate init class property depends on another in constructor
1616

1717
This is not allowed now.
1818

‎docs/en/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Works on TypeScript and decorator.
1616

1717
[](./quick-start/code-what-it-is-example.ts ':include :type=code typescript')
1818

19-
If you like deprecaed [vue-class-component](https://github.com/vuejs/vue-class-component) and deprecated [vue-property-decorator](https://github.com/kaorun343/vue-property-decorator), try this!
19+
If you like deprecated [vue-class-component](https://github.com/vuejs/vue-class-component) and deprecated [vue-property-decorator](https://github.com/kaorun343/vue-property-decorator), try this!
2020

2121
Suggestion and contribution welcome.
2222

‎docs/en/tsx/attribute-types/attribute-types.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ To make enable TSX attribute types:
44

55
1. Import `TSX` function from this repo.
66

7-
2. Define an interface(e.g. `Props`) to decribe properties in component.
7+
2. Define an interface(e.g. `Props`) to describe properties in component.
88

9-
3. Define an interface(e.g. `Events`) to decribe events in component.
9+
3. Define an interface(e.g. `Events`) to describe events in component.
1010

1111
4. Make component extend from `TSX<Props,Events>()(BaseComponent)`.
1212

0 commit comments

Comments
 (0)
Please sign in to comment.