Skip to content

Commit bfc39d4

Browse files
committed
update docs
1 parent bd4eda1 commit bfc39d4

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Internationalization plugin for Vue.js
2121
<br/>
2222

2323

24-
## Status: Alpha ![Test](https://github.com/intlify/vue-i18n-next/workflows/Test/badge.svg)
24+
## Status: Beta ![Test](https://github.com/intlify/vue-i18n-next/workflows/Test/badge.svg)
2525

2626
The current codebase has most of the existing features on Vue I18n v8.x and is usable.
2727

@@ -31,6 +31,16 @@ If you use stable Vue I18n version, see this [repository](https://github.com/kaz
3131

3232
## :star: New Features
3333

34+
### Message Format Syntax
35+
- Literal Interpolation
36+
- You can use a single quote `'` and "Mustache" like (`{` `}` ) to make the message literal.
37+
- e.g. `foo{'@'}domain.com`
38+
- Message Functions
39+
- As Vue's render function, vue-i18n-next and later support the **Message** functions.
40+
- Using the Message function has the following advantages
41+
- Accelerate evaluation of vue-i18n messages (pre-compilation)
42+
- Support for complex i18n that cannot be handled by message format
43+
3444
### Composable API
3545

3646
New style API for Vue 3. See the following docs:
@@ -76,6 +86,13 @@ The examples are offered that use the following two API styles:
7686

7787
### :boom: Breaking changes compared to vue-i18n v8.x
7888

89+
#### Message Format Syntax
90+
- Special characters
91+
- Since vue-i18n-next, message format syntax is handled by the compiler.
92+
- The following characters used in the message syntax are processed by the compiler as special characters:
93+
- `{`, `}`, `@`, `$`, `|`
94+
- If you want to use these special characters, you can use **lietral interpolation** to get around it:
95+
7996
#### APIs
8097
- The return value of `$t` and `t` methods is **string** only. object and array values ​​are no longer returned.
8198
- As an alternative way, you can use `$tm` / `tm`

0 commit comments

Comments
 (0)