Merge branch 'winh-sprintf-no-escape-docs' into 'master'
Document example for sprintf without escaping See merge request gitlab-org/gitlab-ce!16712
This commit is contained in:
commit
8206cae781
|
@ -131,6 +131,9 @@ There is also and alternative method to [translate messages from validation erro
|
||||||
|
|
||||||
### Interpolation
|
### Interpolation
|
||||||
|
|
||||||
|
Placeholders in translated text should match the code style of the respective source file.
|
||||||
|
For example use `%{created_at}` in Ruby but `%{createdAt}` in JavaScript.
|
||||||
|
|
||||||
- In Ruby/HAML:
|
- In Ruby/HAML:
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
|
@ -141,11 +144,19 @@ There is also and alternative method to [translate messages from validation erro
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { __, sprintf } from '~/locale';
|
import { __, sprintf } from '~/locale';
|
||||||
sprintf(__('Hello %{username}'), { username: 'Joe' }) => 'Hello Joe'
|
|
||||||
|
sprintf(__('Hello %{username}'), { username: 'Joe' }); // => 'Hello Joe'
|
||||||
```
|
```
|
||||||
|
|
||||||
The placeholders should match the code style of the respective source file.
|
By default, `sprintf` escapes the placeholder values.
|
||||||
For example use `%{created_at}` in Ruby but `%{createdAt}` in JavaScript.
|
If you want to take care of that yourself, you can pass `false` as third argument.
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { __, sprintf } from '~/locale';
|
||||||
|
|
||||||
|
sprintf(__('This is %{value}'), { value: '<strong>bold</strong>' }); // => 'This is <strong>bold</strong>'
|
||||||
|
sprintf(__('This is %{value}'), { value: '<strong>bold</strong>' }, false); // => 'This is <strong>bold</strong>'
|
||||||
|
```
|
||||||
|
|
||||||
### Plurals
|
### Plurals
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue