Skip to content

rename disableSpecialChars opions #1903

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

Merged
merged 3 commits into from
Jul 29, 2019
Merged

rename disableSpecialChars opions #1903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8db282
Revert "Added documentation for disableSpecialCharSequences option fo…
kuceb Jul 23, 2019
d235027
rename disableSpecialCharSequences
kuceb Jul 23, 2019
56698e3
fix description of 'parseSpecial...' - was opposite meaning, still me…
jennifer-shehane Jul 24, 2019
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
12 changes: 10 additions & 2 deletions source/api/commands/type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ cy.url().type('www.cypress.io') // Errors, 'url' does not yield DOM element

The text to be typed into the DOM element.

Text passed to `.type()` may include any of these special character sequences:
Text passed to `.type()` may include any of the special character sequences below.

{% note info %}
To disable parsing special characters sequences, set the `parseSpecialCharSequences` option to `false`.
{% endnote %}

Sequence | Notes
--- | ---
Expand Down Expand Up @@ -70,8 +74,8 @@ Option | Default | Description
`log` | `true` | {% usage_options log %}
`delay` | `10` | Delay after each keypress
`force` | `false` | {% usage_options force type %}
`parseSpecialCharSequences` | `true` | Parse special characters for strings surrounded by `{}`, such as `{esc}`. Set to `false` to type the literal characters instead
`release` | `true` | Keep a modifier activated between commands
`disableSpecialCharSequences` | `false` | Disable typing special characters for strings surrounded by `{}`, such as `{esc}`, and type the literal characters instead
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .type %}

## Yields {% helper_icon yields %}
Expand Down Expand Up @@ -166,6 +170,10 @@ Special characters (`{leftarrow}`, `{selectall}`, etc.) are not permitted.

When using special character sequences, it's possible to activate modifier keys and type key combinations, such as `CTRL + R` or `SHIFT + ALT + Q`. The modifier(s) remain activated for the duration of the `.type()` command, and are released when all subsequent characters are typed, unless {% url '`{release: false}`' type#Options %} is passed as an {% url 'option' type#Key-Combinations %}. A `keydown` event is fired when a modifier is activated and a `keyup` event is fired when it is released.

{% note info %}
To disable parsing special characters sequences, set the `parseSpecialCharSequences` option to `false`.
{% endnote %}

### Type a key combination

```javascript
Expand Down
12 changes: 10 additions & 2 deletions source/ja/api/commands/type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ cy.url().type('www.cypress.io') // Errors, 'url' does not yield DOM element

The text to be typed into the DOM element.

Text passed to `.type()` may include any of these special character sequences:
Text passed to `.type()` may include any of the special character sequences below.

{% note info %}
To disable parsing special characters sequences, set the `parseSpecialCharSequences` option to `false`.
{% endnote %}

Sequence | Notes
--- | ---
Expand Down Expand Up @@ -70,8 +74,8 @@ Option | Default | Description
`log` | `true` | {% usage_options log %}
`delay` | `10` | Delay after each keypress
`force` | `false` | {% usage_options force type %}
`parseSpecialCharSequences` | `true` | Parse special characters for strings surrounded by `{}`, such as `{esc}`. Set to `false` to type the literal characters instead
`release` | `true` | Keep a modifier activated between commands
`disableSpecialCharSequences` | `false` | Disable typing special characters for strings surrounded by `{}`, such as `{esc}`, and type the literal characters instead
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .type %}

## Yields {% helper_icon yields %}
Expand Down Expand Up @@ -166,6 +170,10 @@ Special characters (`{leftarrow}`, `{selectall}`, etc.) are not permitted.

When using special character sequences, it's possible to activate modifier keys and type key combinations, such as `CTRL + R` or `SHIFT + ALT + Q`. The modifier(s) remain activated for the duration of the `.type()` command, and are released when all subsequent characters are typed, unless {% url '`{release: false}`' type#Options %} is passed as an {% url 'option' type#Key-Combinations %}. A `keydown` event is fired when a modifier is activated and a `keyup` event is fired when it is released.

{% note info %}
To disable parsing special characters sequences, set the `parseSpecialCharSequences` option to `false`.
{% endnote %}

### Type a key combination

```javascript
Expand Down
12 changes: 10 additions & 2 deletions source/zh-cn/api/commands/type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ cy.url().type('www.cypress.io') // Errors, 'url' does not yield DOM element

The text to be typed into the DOM element.

Text passed to `.type()` may include any of these special character sequences:
Text passed to `.type()` may include any of the special character sequences below.

{% note info %}
To disable parsing special characters sequences, set the `parseSpecialCharSequences` option to `false`.
{% endnote %}

Sequence | Notes
--- | ---
Expand Down Expand Up @@ -70,8 +74,8 @@ Option | Default | Description
`log` | `true` | {% usage_options log %}
`delay` | `10` | Delay after each keypress
`force` | `false` | {% usage_options force type %}
`parseSpecialCharSequences` | `true` | Parse special characters for strings surrounded by `{}`, such as `{esc}`. Set to `false` to type the literal characters instead
`release` | `true` | Keep a modifier activated between commands
`disableSpecialCharSequences` | `false` | Disable typing special characters for strings surrounded by `{}`, such as `{esc}`, and type the literal characters instead
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .type %}

## Yields {% helper_icon yields %}
Expand Down Expand Up @@ -166,6 +170,10 @@ Special characters (`{leftarrow}`, `{selectall}`, etc.) are not permitted.

When using special character sequences, it's possible to activate modifier keys and type key combinations, such as `CTRL + R` or `SHIFT + ALT + Q`. The modifier(s) remain activated for the duration of the `.type()` command, and are released when all subsequent characters are typed, unless {% url '`{release: false}`' type#Options %} is passed as an {% url 'option' type#Key-Combinations %}. A `keydown` event is fired when a modifier is activated and a `keyup` event is fired when it is released.

{% note info %}
To disable parsing special characters sequences, set the `parseSpecialCharSequences` option to `false`.
{% endnote %}

### Type a key combination

```javascript
Expand Down