Skip to content

Commit 26c3fb7

Browse files
kazuponkazupon
committed
update docs
1 parent cd5492c commit 26c3fb7

19 files changed

+109
-88
lines changed

‎docs/vue-i18n.composer.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
Composer Interfaces
88

9-
This is the interface for being used for Vue 3 Composition API.
10-
119
<b>Signature:</b>
1210

1311
```typescript
@@ -76,3 +74,8 @@ export declare type Composer = {
7674
__datetimeParts(...args: unknown[]): string | Intl.DateTimeFormatPart[];
7775
};
7876
```
77+
78+
## Remarks
79+
80+
This is the interface for being used for Vue 3 Composition API.
81+

‎docs/vue-i18n.composeradditionaloptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## ComposerAdditionalOptions interface
66

7-
Composer additional options
7+
Composer additional options for `useI18n`
88

99
<b>Signature:</b>
1010

‎docs/vue-i18n.composeroptions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66

77
Composer Options
88

9-
This is options to create composer.
10-
119
<b>Signature:</b>
1210

1311
```typescript
1412
export interface ComposerOptions
1513
```
1614

15+
## Remarks
16+
17+
This is options to create composer.
18+
1719
## Properties
1820

1921
| Property | Type | Description |

‎docs/vue-i18n.createi18n.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export declare function createI18n(options?: I18nOptions): I18n;
2626

2727
## Remarks
2828

29-
When you use Composable API, you need to specify options of [ComposerOptions](./vue-i18n.composeroptions.md)<!-- -->. When you use Legacy API, you need toto specify options of [VueI18nOptions](./vue-i18n.vuei18noptions.md) and `legacy: true`<!-- -->.
29+
When you use Composable API, you need to specify options of [ComposerOptions](./vue-i18n.composeroptions.md)<!-- -->. When you use Legacy API, you need toto specify options of [VueI18nOptions](./vue-i18n.vuei18noptions.md) and `legacy: true` option.
3030

3131
## Example 1
3232

‎docs/vue-i18n.i18n.global.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [I18n](./vue-i18n.i18n.md) &gt; [global](./vue-i18n.i18n.global.md)
4+
5+
## I18n.global property
6+
7+
Global composer
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
readonly global: Composer;
13+
```

‎docs/vue-i18n.i18n.install.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎docs/vue-i18n.i18n.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@ export interface I18n
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19-
| [mode](./vue-i18n.i18n.mode.md) | <code>I18nMode</code> | |
20-
21-
## Methods
22-
23-
| Method | Description |
24-
| --- | --- |
25-
| [install(app, options)](./vue-i18n.i18n.install.md) | |
19+
| [global](./vue-i18n.i18n.global.md) | <code>Composer</code> | Global composer |
20+
| [mode](./vue-i18n.i18n.mode.md) | <code>I18nMode</code> | I18n API mode |
2621

‎docs/vue-i18n.i18n.mode.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44

55
## I18n.mode property
66

7+
I18n API mode
8+
79
<b>Signature:</b>
810

911
```typescript
1012
readonly mode: I18nMode;
1113
```
14+
15+
## Remarks
16+
17+
if you specified `legacy: true` option in `createI18n`<!-- -->, return `legacy`<!-- -->, else `composable`
18+

‎docs/vue-i18n.i18nadditionaloptions.legacy.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [I18nAdditionalOptions](./vue-i18n.i18nadditionaloptions.md) &gt; [legacy](./vue-i18n.i18nadditionaloptions.legacy.md)
4+
5+
## I18nAdditionalOptions.legacy property
6+
7+
Whether vue-i18n legacy API use on your Vue App.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
legacy?: boolean;
13+
```

‎docs/vue-i18n.i18nadditionaloptions.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [I18nAdditionalOptions](./vue-i18n.i18nadditionaloptions.md)
4+
5+
## I18nAdditionalOptions interface
6+
7+
I18n Additional Options for `createI18n`
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface I18nAdditionalOptions
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [legacy](./vue-i18n.i18nadditionaloptions.legacy.md) | <code>boolean</code> | Whether vue-i18n legacy API use on your Vue App. |
20+

‎docs/vue-i18n.i18naddtionaloptions.legacy.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎docs/vue-i18n.i18naddtionaloptions.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎docs/vue-i18n.i18noptions.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44

55
## I18nOptions type
66

7+
I18n Options for `createI18n`
8+
79
<b>Signature:</b>
810

911
```typescript
10-
export declare type I18nOptions = I18nAddtionalOptions & (ComposerOptions | VueI18nOptions);
12+
export declare type I18nOptions = I18nAdditionalOptions & (ComposerOptions | VueI18nOptions);
1113
```
14+
15+
## Remarks
16+
17+
`I18nOptions` is inherited [I18nAdditionalOptions](./vue-i18n.i18nadditionaloptions.md)<!-- -->, [ComposerOptions](./vue-i18n.composeroptions.md) and [VueI18nOptions](./vue-i18n.vuei18noptions.md)<!-- -->, so you can specify these options.
18+

‎docs/vue-i18n.i18npluginoptions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@
44

55
## I18nPluginOptions interface
66

7+
I18n plugin options
8+
79
<b>Signature:</b>
810

911
```typescript
1012
export interface I18nPluginOptions
1113
```
1214

15+
## Remarks
16+
17+
An options specified when installing vue-i18n as Vue plugin with using `app.use`<!-- -->.
18+
1319
## Properties
1420

1521
| Property | Type | Description |

‎docs/vue-i18n.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@
2525
| Interface | Description |
2626
| --- | --- |
2727
| [CompileError](./vue-i18n.compileerror.md) | |
28-
| [ComposerAdditionalOptions](./vue-i18n.composeradditionaloptions.md) | Composer additional options |
29-
| [ComposerOptions](./vue-i18n.composeroptions.md) | Composer Options<!-- -->This is options to create composer. |
28+
| [ComposerAdditionalOptions](./vue-i18n.composeradditionaloptions.md) | Composer additional options for <code>useI18n</code> |
29+
| [ComposerOptions](./vue-i18n.composeroptions.md) | Composer Options |
3030
| [CurrencyNumberFormatOptions](./vue-i18n.currencynumberformatoptions.md) | |
3131
| [Formatter](./vue-i18n.formatter.md) | |
3232
| [I18n](./vue-i18n.i18n.md) | I18n interface |
33-
| [I18nAddtionalOptions](./vue-i18n.i18naddtionaloptions.md) | I18n Options |
34-
| [I18nPluginOptions](./vue-i18n.i18npluginoptions.md) | |
33+
| [I18nAdditionalOptions](./vue-i18n.i18nadditionaloptions.md) | I18n Additional Options for <code>createI18n</code> |
34+
| [I18nPluginOptions](./vue-i18n.i18npluginoptions.md) | I18n plugin options |
3535
| [SpecificDateTimeFormatOptions](./vue-i18n.specificdatetimeformatoptions.md) | |
3636
| [SpecificNumberFormatOptions](./vue-i18n.specificnumberformatoptions.md) | |
37-
| [VueI18nOptions](./vue-i18n.vuei18noptions.md) | VueI18n Options<!-- -->This option is compatible with the constructor options of <code>VueI18n</code> class (offered with vue-i18n<!-- -->@<!-- -->8.x). |
37+
| [VueI18nOptions](./vue-i18n.vuei18noptions.md) | VueI18n Options |
3838

3939
## Variables
4040

@@ -43,7 +43,7 @@
4343
| [Availabilities](./vue-i18n.availabilities.md) | |
4444
| [friendlyJSONstringify](./vue-i18n.friendlyjsonstringify.md) | |
4545
| [generateFormatCacheKey](./vue-i18n.generateformatcachekey.md) | |
46-
| [VERSION](./vue-i18n.version.md) | |
46+
| [VERSION](./vue-i18n.version.md) | vue-i18n version |
4747

4848
## Type Aliases
4949

@@ -53,7 +53,7 @@
5353
| [CompileDomain](./vue-i18n.compiledomain.md) | |
5454
| [CompileErrorHandler](./vue-i18n.compileerrorhandler.md) | |
5555
| [CompileOptions](./vue-i18n.compileoptions.md) | |
56-
| [Composer](./vue-i18n.composer.md) | Composer Interfaces<!-- -->This is the interface for being used for Vue 3 Composition API. |
56+
| [Composer](./vue-i18n.composer.md) | Composer Interfaces |
5757
| [CurrencyDisplay](./vue-i18n.currencydisplay.md) | number |
5858
| [DateTimeDigital](./vue-i18n.datetimedigital.md) | |
5959
| [DateTimeFormat](./vue-i18n.datetimeformat.md) | |
@@ -65,7 +65,7 @@
6565
| [FormattedNumberPart](./vue-i18n.formattednumberpart.md) | |
6666
| [FormattedNumberPartType](./vue-i18n.formattednumberparttype.md) | |
6767
| [I18nMode](./vue-i18n.i18nmode.md) | I18n API mode |
68-
| [I18nOptions](./vue-i18n.i18noptions.md) | |
68+
| [I18nOptions](./vue-i18n.i18noptions.md) | I18n Options for <code>createI18n</code> |
6969
| [I18nScope](./vue-i18n.i18nscope.md) | I18n Scope |
7070
| [IntlAvailability](./vue-i18n.intlavailability.md) | datetime |
7171
| [LinkedModifiers](./vue-i18n.linkedmodifiers.md) | |
@@ -89,7 +89,7 @@
8989
| [PluralizationRulesMap](./vue-i18n.pluralizationrulesmap.md) | |
9090
| [PostTranslationHandler](./vue-i18n.posttranslationhandler.md) | |
9191
| [TranslateResult](./vue-i18n.translateresult.md) | |
92-
| [UseI18nOptions](./vue-i18n.usei18noptions.md) | |
93-
| [VueI18n](./vue-i18n.vuei18n.md) | VueI18n Interfaces<!-- -->This interface is compatible with interface of <code>VueI18n</code> class (offered with vue-i18n<!-- -->@<!-- -->8.x). |
92+
| [UseI18nOptions](./vue-i18n.usei18noptions.md) | I18n Options for <code>useI18n</code> |
93+
| [VueI18n](./vue-i18n.vuei18n.md) | VueI18n Interfaces |
9494
| [WarnHtmlInMessageLevel](./vue-i18n.warnhtmlinmessagelevel.md) | |
9595

‎docs/vue-i18n.usei18noptions.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44

55
## UseI18nOptions type
66

7+
I18n Options for `useI18n`
8+
79
<b>Signature:</b>
810

911
```typescript
1012
export declare type UseI18nOptions = ComposerAdditionalOptions & ComposerOptions;
1113
```
14+
15+
## Remarks
16+
17+
`UseI18nOptions` is inherited [ComposerAdditionalOptions](./vue-i18n.composeradditionaloptions.md) and [ComposerOptions](./vue-i18n.composeroptions.md)<!-- -->, so you can specify these options.
18+

‎docs/vue-i18n.version.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## VERSION variable
66

7+
vue-i18n version
8+
79
<b>Signature:</b>
810

911
```typescript

‎docs/vue-i18n.vuei18n.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
VueI18n Interfaces
88

9-
This interface is compatible with interface of `VueI18n` class (offered with vue-i18n<!-- -->@<!-- -->8.x).
10-
119
<b>Signature:</b>
1210

1311
```typescript
@@ -29,6 +27,7 @@ export declare type VueI18n = {
2927
formatFallbackMessages: boolean;
3028
sync: boolean;
3129
warnHtmlInMessage: WarnHtmlInMessageLevel;
30+
preserveDirectiveContent: boolean;
3231
__id: number;
3332
__composer: Composer;
3433
/*!
@@ -77,3 +76,8 @@ export declare type VueI18n = {
7776
getChoiceIndex: (choice: Choice, choicesLength: number) => number;
7877
};
7978
```
79+
80+
## Remarks
81+
82+
This interface is compatible with interface of `VueI18n` class (offered with vue-i18n<!-- -->@<!-- -->8.x).
83+

‎docs/vue-i18n.vuei18noptions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66

77
VueI18n Options
88

9-
This option is compatible with the constructor options of `VueI18n` class (offered with vue-i18n<!-- -->@<!-- -->8.x).
10-
119
<b>Signature:</b>
1210

1311
```typescript
1412
export interface VueI18nOptions
1513
```
1614

15+
## Remarks
16+
17+
This option is compatible with the constructor options of `VueI18n` class (offered with vue-i18n<!-- -->@<!-- -->8.x).
18+
1719
## Properties
1820

1921
| Property | Type | Description |

0 commit comments

Comments
 (0)