Skip to content

replace "required" column in code reference with special label #1959

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
nearestnabors merged 4 commits into from
Jul 15, 2020
Merged

replace "required" column in code reference with special label #1959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b567aa0
replace "required" column in code reference with special label
Simek May 29, 2020
8177127
Merge branch 'master' into required-label
Simek Jun 6, 2020
d8faa41
Merge branch 'master' into required-label
Simek Jun 18, 2020
9af918e
Merge branch 'master' into required-label
Jul 15, 2020
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
24 changes: 12 additions & 12 deletions docs/activityindicator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,36 +96,36 @@ Inherits [View Props](view#props).

Whether to show the indicator (`true`) or hide it (`false`).

| Type | Required | Default |
| ---- | -------- | ------- |
| bool | No | `true` |
| Type | Default |
| ---- | ------- |
| bool | `true` |

---

### `color`

The foreground color of the spinner.

| Type | Required | Default |
| --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [color](colors) | No | `null` (system accent default color)<div class="label android">Android</div><hr/><ins style="background: #999" class="color-box"></ins>`'#999999'` <div class="label ios">iOS</div> |
| Type | Default |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [color](colors) | `null` (system accent default color)<div class="label android">Android</div><hr/><ins style="background: #999" class="color-box"></ins>`'#999999'` <div class="label ios">iOS</div> |

---

### `hidesWhenStopped` <div class="label ios">iOS</div>

Whether the indicator should hide when not animating.

| Type | Required | Default |
| ---- | -------- | ------- |
| bool | No | `true` |
| Type | Default |
| ---- | ------- |
| bool | `true` |

---

### `size`

Size of the indicator.

| Type | Required | Default |
| ------------------------------------------------------------------------------ | -------- | --------- |
| enum(`'small'`, `'large'`)<hr/>number <div class="label android">Android</div> | No | `'small'` |
| Type | Default |
| ------------------------------------------------------------------------------ | --------- |
| enum(`'small'`, `'large'`)<hr/>number <div class="label android">Android</div> | `'small'` |
84 changes: 42 additions & 42 deletions docs/button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,130 +108,130 @@ export default App;

## Props

### **`onPress`**
### <div class="label required basic">Required</div>**`onPress`**

Handler to be called when the user taps the button. The first function argument is an event in form of [PressEvent](pressevent).
Handler to be called when the user taps the button.

| Type | Required |
| -------- | -------- |
| function | Yes |
| Type |
| ---------------------------------- |
| function([PressEvent](pressevent)) |

---

### **`title`**
### <div class="label required basic">Required</div>**`title`**

Text to display inside the button. On Android the given title will be converted to the uppercased form.

| Type | Required |
| ------ | -------- |
| string | Yes |
| Type |
| ------ |
| string |

---

### `accessibilityLabel`

Text to display for blindness accessibility features.

| Type | Required |
| ------ | -------- |
| string | No |
| Type |
| ------ |
| string |

---

### `color`

Color of the text (iOS), or background color of the button (Android).

| Type | Required | Default |
| --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [color](colors) | No | <ins style="background: #2196F3" class="color-box"></ins>`'#2196F3'` <div class="label android">Android</div><hr/><ins style="background: #007AFF" class="color-box"></ins>`'#007AFF'` <div class="label ios">iOS</div> |
| Type | Default |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [color](colors) | <ins style="background: #2196F3" class="color-box"></ins>`'#2196F3'` <div class="label android">Android</div><hr/><ins style="background: #007AFF" class="color-box"></ins>`'#007AFF'` <div class="label ios">iOS</div> |

---

### `disabled`

If `true`, disable all interactions for this component.

| Type | Required | Default |
| ---- | -------- | ------- |
| bool | No | `false` |
| Type | Default |
| ---- | ------- |
| bool | `false` |

---

### `hasTVPreferredFocus` <div class="label tv">TV</div>

TV preferred focus.

| Type | Required | Default |
| ---- | -------- | ------- |
| bool | No | `false` |
| Type | Default |
| ---- | ------- |
| bool | `false` |

---

### `nextFocusDown` <div class="label android">Android</div><div class="label tv">TV</div>

Designates the next view to receive focus when the user navigates down. See the [Android documentation](https://developer.android.com/reference/android/view/View.html#attr_android:nextFocusDown).

| Type | Required |
| ------ | -------- |
| number | No |
| Type |
| ------ |
| number |

---

### `nextFocusForward` <div class="label android">Android</div><div class="label tv">TV</div>

Designates the next view to receive focus when the user navigates forward. See the [Android documentation](https://developer.android.com/reference/android/view/View.html#attr_android:nextFocusForward).

| Type | Required |
| ------ | -------- |
| number | No |
| Type |
| ------ |
| number |

---

### `nextFocusLeft` <div class="label android">Android</div><div class="label tv">TV</div>

Designates the next view to receive focus when the user navigates left. See the [Android documentation](https://developer.android.com/reference/android/view/View.html#attr_android:nextFocusLeft).

| Type | Required |
| ------ | -------- |
| number | No |
| Type |
| ------ |
| number |

---

### `nextFocusRight` <div class="label android">Android</div><div class="label tv">TV</div>

Designates the next view to receive focus when the user navigates right. See the [Android documentation](https://developer.android.com/reference/android/view/View.html#attr_android:nextFocusRight).

| Type | Required |
| ------ | -------- |
| number | No |
| Type |
| ------ |
| number |

---

### `nextFocusUp` <div class="label android">Android</div><div class="label tv">TV</div>

Designates the next view to receive focus when the user navigates up. See the [Android documentation](https://developer.android.com/reference/android/view/View.html#attr_android:nextFocusUp).

| Type | Required |
| ------ | -------- |
| number | No |
| Type |
| ------ |
| number |

---

### `testID`

Used to locate this view in end-to-end tests.

| Type | Required |
| ------ | -------- |
| string | No |
| Type |
| ------ |
| string |

---

### `touchSoundDisabled` <div class="label android">Android</div>

If `true`, doesn't play system sound on touch.

| Type | Required | Default |
| ------- | -------- | ------- |
| boolean | No | `false` |
| Type | Default |
| ------- | ------- |
| boolean | `false` |
Loading