Skip to content

Commit

Permalink
Generating Props
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmfriedman committed Sep 11, 2020
1 parent 39f27f5 commit 6701506
Show file tree
Hide file tree
Showing 11 changed files with 35 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/badge/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Badges `RMWC ADDON`

> Badges are small status descriptors for UI elements. A badge consists of a small circle, typically containing a number or other short set of characters, that appears in proximity to another object.
Badges are small status descriptors for UI elements. A badge consists of a small circle, typically containing a number or other short set of characters, that appears in proximity to another object.

- Module **@rmwc/badge**
- Import styles:
Expand Down
2 changes: 1 addition & 1 deletion src/circular-progress/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Circular Progress `RMWC ADDON`

> Circular progress indicators display progress by animating an indicator along an invisible circular track in a clockwise direction. They can be applied directly to a surface, such as a button or card.
Circular progress indicators display progress by animating an indicator along an invisible circular track in a clockwise direction. They can be applied directly to a surface, such as a button or card.

- Module **@rmwc/circular-progress**
- Import styles:
Expand Down
2 changes: 1 addition & 1 deletion src/drawer/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Drawers

> A navigation drawer slides in from the left and contains the navigation destinations for your app.
A navigation drawer slides in from the left and contains the navigation destinations for your app.

- Module **@rmwc/drawer**
- Import styles:
Expand Down
2 changes: 1 addition & 1 deletion src/elevation/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Elevation

> Elevation is the relative distance between two surfaces along the z-axis.
Elevation is the relative distance between two surfaces along the z-axis.

- Module **@rmwc/elevation**
- Import styles:
Expand Down
2 changes: 1 addition & 1 deletion src/formfield/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Form Fields

> MDC Form Field provides an mdc-formfield helper class for easily making theme-aware, RTL-aware form field + label combos. It also provides an MDCFormField class for easily making input ripples respond to label events.
MDC Form Field provides an mdc-formfield helper class for easily making theme-aware, RTL-aware form field + label combos. It also provides an MDCFormField class for easily making input ripples respond to label events.

- Module **@rmwc/formfield**
- Import styles:
Expand Down
2 changes: 1 addition & 1 deletion src/grid/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Layout Grid

> Material design’s responsive UI is based on a column-variate grid layout. It has 12 columns on desktop, 8 columns on tablet and 4 columns on phone.
Material design’s responsive UI is based on a column-variate grid layout. It has 12 columns on desktop, 8 columns on tablet and 4 columns on phone.

- Module **@rmwc/grid**
- Import styles:
Expand Down
2 changes: 1 addition & 1 deletion src/image-list/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Image Lists

> MDC Image List provides a RTL-aware Material Design image list component, representing an evolution of the Material Design Grid List spec. An Image List consists of several items, each containing an image and optionally supporting content (i.e. a text label).
MDC Image List provides a RTL-aware Material Design image list component, representing an evolution of the Material Design Grid List spec. An Image List consists of several items, each containing an image and optionally supporting content (i.e. a text label).

- Module **@rmwc/image-list**
- Import styles:
Expand Down
2 changes: 1 addition & 1 deletion src/linear-progress/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Linear Progress

> Progress and activity indicators are visual indications of an app loading content.
Progress and activity indicators are visual indications of an app loading content.

- Module **@rmwc/linear-progress**
- Import styles:
Expand Down
2 changes: 1 addition & 1 deletion src/slider/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sliders

> Sliders let users select from a range of values by moving the slider thumb.
Sliders let users select from a range of values by moving the slider thumb.

- Module **@rmwc/slider**
- Import styles:
Expand Down
1 change: 1 addition & 0 deletions src/tabs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ A Tab component
| Name | Type | Description |
|------|------|-------------|
| `children` | `React.ReactNode` | The label for the tab, passed as children. |
| `focusOnActivate` | `undefined \| false \| true` | Focuses the tab when activated. Defaults to true. |
| `foundationRef` | `React.Ref<MDCTabFoundation \| null>` | Advanced: A reference to the MDCFoundation. |
| `icon` | `RMWC.IconPropT` | The icon to use for the tab. |
| `iconIndicator` | `RMWC.IconPropT` | Optionally use a custom icon for the active indicator, instead of the underline. |
Expand Down
26 changes: 25 additions & 1 deletion src/tabs/generated-props.json
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,30 @@
"sourceUrl": "https://github.com/jamesmfriedman/rmwc/blob/master/src/tabs/tab.tsx#L26",
"type": "React.ReactNode"
},
{
"documentation": {
"contents": [
"<p>Focuses the tab when activated. Defaults to true.</p>\n"
],
"contentsRaw": "Focuses the tab when activated. Defaults to true.",
"metadata": {}
},
"fileName": "src/tabs/tab.tsx",
"flags": {
"isExported": true,
"isExternal": false,
"isOptional": true,
"isPrivate": false,
"isProtected": false,
"isPublic": false,
"isRest": false,
"isStatic": false
},
"kind": "property",
"name": "focusOnActivate",
"sourceUrl": "https://github.com/jamesmfriedman/rmwc/blob/master/src/tabs/tab.tsx#L42",
"type": "undefined | false | true"
},
{
"documentation": {
"contents": [
Expand Down Expand Up @@ -550,7 +574,7 @@
},
"kind": "type alias",
"name": "TabApi",
"sourceUrl": "https://github.com/jamesmfriedman/rmwc/blob/master/src/tabs/tab.tsx#L43",
"sourceUrl": "https://github.com/jamesmfriedman/rmwc/blob/master/src/tabs/tab.tsx#L45",
"type": ""
},
"TabBarOnActivateEventT": {
Expand Down

0 comments on commit 6701506

Please sign in to comment.