Skip to content
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

Jump to bottom

docs: update documentation for deprecated components #2479

Merged
merged 1 commit into from
Aug 23, 2023
Merged

docs: update documentation for deprecated components #2479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/CheckBoxGroup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ status: 'Deprecate Soon'
designStatus: 'To Do'
devStatus: 'To Do'
notes: |
Refactor to use Input component and refresh checkbox designs
Replaced by Form.Checkbox and Form.CheckboxSet
---

## Basic Usage
Expand Down
18 changes: 9 additions & 9 deletions src/InputSelect/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ status: 'Deprecate Soon'
designStatus: 'TBD'
devStatus: 'To Do'
notes: |
Replaced by Input and ValidationFormGroup
Replaced by Form.Control
---

## basic usage
## Basic usage

```jsx live
<InputSelect
Expand All @@ -28,7 +28,7 @@ notes: |
/>
```

## separate labels and values
## Separate labels and values

```jsx live
<InputSelect
Expand All @@ -46,7 +46,7 @@ notes: |
/>
```

## separate option groups
## Separate option groups

```jsx live
<InputSelect
Expand Down Expand Up @@ -82,7 +82,7 @@ notes: |
/>
```

## with validation
## With validation

```jsx live
<InputSelect
Expand All @@ -102,16 +102,16 @@ notes: |
/>
```

## disabled usage
## Disabled usage

```jsx live
<InputSelect
name="fruits"
label="Fruits"
aria-label="Fruits"
value="strawberry"
options={['
apple',
options={[
'apple',
'orange',
'strawberry',
'banana',
Expand All @@ -120,7 +120,7 @@ notes: |
/>
```

## with disabled option
## With disabled option

```jsx live
<InputSelect
Expand Down
22 changes: 11 additions & 11 deletions src/InputText/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ status: 'Deprecate Soon'
designStatus: 'TBD'
devStatus: 'To Do'
notes: |
Replaced by Input and ValidationFormGroup
Replaced by Form.Control
---

## minimal usage
## Minimal usage

```jsx live
<InputText name="name" label="First Name" value="Foo Bar" />
```

## read only
## Read only

```jsx live
<InputText name="inputState" label="Input State" value="Read Only" readOnly />
```

## validation
## Validation

```jsx live
<InputText
Expand All @@ -45,7 +45,7 @@ notes: |
/>
```

### validation with danger theme
### Validation with danger theme

```jsx live
<InputText
Expand All @@ -67,7 +67,7 @@ notes: |
/>
```

### label as element
### Label as element

```jsx live
<InputText
Expand All @@ -77,7 +77,7 @@ notes: |
/>
```

### focus test
### Focus test

```jsx live
class FocusInputWrapper extends React.Component {
Expand Down Expand Up @@ -118,7 +118,7 @@ class FocusInputWrapper extends React.Component {
}
```

### different textual input types
### Different textual input types

```jsx live
<form>
Expand Down Expand Up @@ -209,7 +209,7 @@ class FocusInputWrapper extends React.Component {
</form>
```

### price with step
### Price with step

```jsx live
<InputText
Expand All @@ -222,13 +222,13 @@ class FocusInputWrapper extends React.Component {
/>
```

### displayed inline
### Displayed inline

```jsx live
<InputText name="username" label="Username" value="foobar" inline />
```

### with input group addons
### With input group addons

```jsx live
<form>
Expand Down
7 changes: 3 additions & 4 deletions src/RadioButtonGroup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@ status: 'Deprecate Soon'
designStatus: 'To Do'
devStatus: 'To Do'
notes: |
Refactor to use Input component
and refresh checkbox designs
Replaced by Form.Radio and From.RadioSet
---

## unselected minimal usage
## Unselected minimal usage

```jsx live
<RadioButtonGroup
Expand All @@ -31,7 +30,7 @@ notes: |
</RadioButtonGroup>
```

## selected minimal usage
## Selected minimal usage

```jsx live
<RadioButtonGroup
Expand Down
16 changes: 8 additions & 8 deletions src/Table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ status: 'Deprecate soon'
designStatus: 'TBD'
devStatus: 'TBD'
notes: |
Potentially does too much work. Consider if should be multiple components: Table, TableHeader, SortableTable, etc.
Replaced by DataTable
---

## unstyled
## Unstyled

```jsx live
<Table
Expand Down Expand Up @@ -77,7 +77,7 @@ notes: |
/>
```

## table-striped
## Table-striped

```jsx live
<Table
Expand Down Expand Up @@ -143,7 +143,7 @@ notes: |
/>
```

## default heading
## Default heading

```jsx live
<Table
Expand Down Expand Up @@ -209,7 +209,7 @@ notes: |
/>
```

## responsive
## Responsive

```jsx live
<Table
Expand Down Expand Up @@ -275,7 +275,7 @@ notes: |
/>
```

## sortable
## Sortable

```jsx live
() => {
Expand Down Expand Up @@ -373,7 +373,7 @@ notes: |
};
```

## fixed
## Fixed

```jsx live
<Table
Expand Down Expand Up @@ -439,7 +439,7 @@ notes: |
/>
```

## row header
## Row header

```jsx live
<Table
Expand Down
10 changes: 5 additions & 5 deletions src/TextArea/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ status: 'Deprecate Soon'
designStatus: 'TBD'
devStatus: 'To Do'
notes: |
Replaced by Input and ValidationFormGroup
Replaced by Form.Control
---

## minimal usage
## Minimal usage

```jsx live
<TextArea
Expand All @@ -22,7 +22,7 @@ notes: |
/>
```

## scrollable
## Scrollable

```jsx live
<TextArea
Expand All @@ -32,7 +32,7 @@ notes: |
/>
```

## validation
## Validation

```jsx live
<TextArea
Expand All @@ -52,7 +52,7 @@ notes: |
/>
```

## label as element
## Label as element

```jsx live
<TextArea
Expand Down
Loading