Skip to content
This repository was archived by the owner on Mar 27, 2019. It is now read-only.

Commit

Permalink
fix prop tables in package READMEs [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
quantizor committed Mar 13, 2017
1 parent f63e241 commit f7af77d
Show file tree
Hide file tree
Showing 20 changed files with 187 additions and 187 deletions.
8 changes: 4 additions & 4 deletions packages/boundless-arrow-key-navigation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,20 +105,20 @@ There are no required props.
(https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

Expects | Default Value
- | -
--- | ---
`any` | `n/a`

- __`component`__ · any valid HTML tag name or a React component factory, anything that can be passed as the first argument to
`React.createElement`

Expects | Default Value
- | -
--- | ---
`string or function` | `'div'`

- __`defaultActiveChildIndex`__ · allows for a particular child to be initially reachable via tabbing; only applied during first render

Expects | Default Value
- | -
--- | ---
`number` | `0`

- __`mode`__ · controls which arrow key events are captured to move active focus within the list:
Expand All @@ -132,7 +132,7 @@ There are no required props.
_Note: focus loops when arrowing past one of the boundaries; tabbing moves the user away from the list._

Expects | Default Value
- | -
--- | ---
`ArrowKeyNavigation.mode.BOTH or ArrowKeyNavigation.mode.HORIZONTAL or ArrowKeyNavigation.mode.VERTICAL` | `ArrowKeyNavigation.mode.BOTH`


8 changes: 4 additions & 4 deletions packages/boundless-async/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ import { Async } from 'boundless';
```

Expects | Default Value
- | -
--- | ---
`function or any renderable or Promise` | `<div />`


Expand All @@ -98,19 +98,19 @@ import { Async } from 'boundless';
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

Expects | Default Value
- | -
--- | ---
`any` | `n/a`

- __`childrenDidRender`__ &middot; a callback for when real content has been rendered; this will be called immediately if normal JSX is passed to Async, or, in the case of a promise, upon resolution or rejection

Expects | Default Value
- | -
--- | ---
`function` | `() => {}`

- __`pendingContent`__ &middot; content to be shown while the promise is in "pending" state (like a loading graphic, perhaps)

Expects | Default Value
- | -
--- | ---
`any renderable` | `<div />`


Expand Down
10 changes: 5 additions & 5 deletions packages/boundless-button/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,33 +116,33 @@ There are no required props.
(https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

Expects | Default Value
- | -
--- | ---
`any` | `n/a`

- __`component`__ &middot; any valid HTML tag name or a ReactComponent, anything that can be passed as the
first argument to `React.createElement`; note that this component sets the `role` and `aria-checked`
attributes so non-`<button>` elements will still behave like a button for screen readers

Expects | Default Value
- | -
--- | ---
`string or function` | `'button'`

- __`onPressed`__ &middot; use this callback instead of `onClick` (it's `onClick` + `onKeyDown:Enter`); fires for both button modes

Expects | Default Value
- | -
--- | ---
`function` | `() => {}`

- __`onUnpressed`__ &middot; called when the element becomes "unpressed"; only fires when the Button is in stateful mode

Expects | Default Value
- | -
--- | ---
`function` | `() => {}`

- __`pressed`__ &middot; passthrough to `aria-pressed`; using this prop turns on the `onUnpressed` callback when applicable

Expects | Default Value
- | -
--- | ---
`bool` | `undefined`


Expand Down
18 changes: 9 additions & 9 deletions packages/boundless-checkbox-group/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ import { CheckboxGroup } from 'boundless';
- __`items`__ &middot; the data wished to be rendered, each item must conform to the [Checkbox prop spec](https://github.com/enigma-io/boundless/blob/master/packages/boundless-checkbox)
Expects | Default Value
- | -
--- | ---
`array` | `[]`
Expand All @@ -159,49 +159,49 @@ import { CheckboxGroup } from 'boundless';
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
Expects | Default Value
- | -
--- | ---
`any` | `n/a`
- __`component`__ &middot; override the wrapper HTML element if desired
Expects | Default Value
- | -
--- | ---
`string` | `'div'`
- __`onAllChecked`__ &middot; called when all children become checked (not fired on first render), no return
Expects | Default Value
- | -
--- | ---
`function` | `() => {}`
- __`onAllUnchecked`__ &middot; called when all children become unchecked (not fired on first render), no return
Expects | Default Value
- | -
--- | ---
`function` | `() => {}`
- __`onChildChecked`__ &middot; called when a specific child has become checked, returns the child definition
Expects | Default Value
- | -
--- | ---
`function` | `() => {}`
- __`onChildUnchecked`__ &middot; called when a specific child has become checked, returns the child definition
Expects | Default Value
- | -
--- | ---
`function` | `() => {}`
- __`selectAll`__ &middot; renders a master checkbox that can manipulate the values of all children simultaneously
Expects | Default Value
- | -
--- | ---
`CheckboxGroup.selectAll.BEFORE or CheckboxGroup.selectAll.AFTER or CheckboxGroup.selectAll.NONE` | `CheckboxGroup.selectAll.BEFORE`
- __`selectAllProps`__ &middot; must conform to the [Checkbox prop spec](./Checkbox)
Expects | Default Value
- | -
--- | ---
`object` | `{}`
Expand Down
14 changes: 7 additions & 7 deletions packages/boundless-checkbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,19 +95,19 @@ There are no required props.
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

Expects | Default Value
- | -
--- | ---
`any` | `n/a`

- __`component`__ &middot; any valid HTML tag name

Expects | Default Value
- | -
--- | ---
`string` | `'div'`

- __`inputProps`__ &middot; all input-specific props like `value`, `name`, etc should be passed here -- common ones are listed below

Expects | Default Value
- | -
--- | ---
`object` | `{
checked: false,
indeterminate: false,
Expand All @@ -116,25 +116,25 @@ There are no required props.
- __`label`__ &middot; any React-renderable content, most commonly a simple string

Expects | Default Value
- | -
--- | ---
`any renderable` | `null`

- __`labelProps`__

Expects | Default Value
- | -
--- | ---
`object` | `{}`

- __`onChecked`__ &middot; called when the element becomes checked; backing data must be updated to persist the state change

Expects | Default Value
- | -
--- | ---
`function` | `() => {}`

- __`onUnchecked`__ &middot; called when the element becomes unchecked; backing data must be updated to persist the state change

Expects | Default Value
- | -
--- | ---
`function` | `() => {}`


Expand Down
26 changes: 13 additions & 13 deletions packages/boundless-dialog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,84 +112,84 @@ There are no required props.
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

Expects | Default Value
- | -
--- | ---
`any` | `n/a`

- __`after`__ &middot; arbitrary content to be rendered after the dialog in the DOM

Expects | Default Value
- | -
--- | ---
`any renderable` | `null`

- __`before`__ &middot; arbitrary content to be rendered before the dialog in the DOM

Expects | Default Value
- | -
--- | ---
`any renderable` | `null`

- __`captureFocus`__ &middot; determines if focus is allowed to move away from the dialog

Expects | Default Value
- | -
--- | ---
`bool` | `true`

- __`closeOnEscKey`__ &middot; enable detection of "Escape" keypresses to trigger `props.onClose`; if a function is provided, the return
value determines if the dialog will be closed

Expects | Default Value
- | -
--- | ---
`bool or function` | `false`

- __`closeOnInsideClick`__ &middot; enable detection of clicks inside the dialog area to trigger `props.onClose`; if a function is provided, the return
value determines if the dialog will be closed

Expects | Default Value
- | -
--- | ---
`bool or function` | `false`

- __`closeOnOutsideClick`__ &middot; enable detection of clicks outside the dialog area to trigger `props.onClose`; if a function is provided, the return
value determines if the dialog will be closed

Expects | Default Value
- | -
--- | ---
`bool or function` | `false`

- __`closeOnOutsideFocus`__ &middot; enable detection of focus outside the dialog area to trigger `props.onClose`; if a function is provided, the return
value determines if the dialog will be closed

Expects | Default Value
- | -
--- | ---
`bool or function` | `false`

- __`closeOnOutsideScroll`__ &middot; enable detection of scroll and mousewheel events outside the dialog area to trigger `props.onClose`; if a function
is provided, the return value determines if the dialog will be closed

Expects | Default Value
- | -
--- | ---
`bool or function` | `false`

- __`component`__ &middot; override the type of `.b-dialog-wrapper` HTML element

Expects | Default Value
- | -
--- | ---
`string` | `'div'`

- __`dialogComponent`__ &middot; override the type of `.b-dialog` HTML element

Expects | Default Value
- | -
--- | ---
`string` | `'div'`

- __`dialogProps`__

Expects | Default Value
- | -
--- | ---
`object` | `{}`

- __`onClose`__ &middot; a custom event handler that is called to indicate that the dialog should be unrendered by its parent; the event occurs if one or more of the "closeOn" props (`closeOnEscKey`, `closeOnOutsideClick`, etc.) are passed as `true` and the dismissal criteria are satisfied

Expects | Default Value
- | -
--- | ---
`function` | `() => {}`


Expand Down
6 changes: 3 additions & 3 deletions packages/boundless-fitted-text/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,20 @@ There are no required props.
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

Expects | Default Value
- | -
--- | ---
`any` | `n/a`

- __`component`__ &middot; any valid HTML tag name

Expects | Default Value
- | -
--- | ---
`string` | `'span'`

- __`upscale`__ &middot; controls if FittedText will automatically scale up the content to fit the available space; normally the component
only scales text down as needed to fit

Expects | Default Value
- | -
--- | ---
`bool` | `false`


Expand Down
8 changes: 4 additions & 4 deletions packages/boundless-image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ import { Image } from 'boundless';
- __`src`__ &middot; a valid path to the desired image

Expects | Default Value
- | -
--- | ---
`string` | `'about:blank'`


Expand All @@ -112,19 +112,19 @@ import { Image } from 'boundless';
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

Expects | Default Value
- | -
--- | ---
`any` | `n/a`

- __`alt`__ &middot; a written description of the image for search engines, hovertext and those using accessibility technologies

Expects | Default Value
- | -
--- | ---
`string` | `''`

- __`component`__ &middot; overrides the component HTML tag

Expects | Default Value
- | -
--- | ---
`string` | `'div'`


Expand Down
Loading

0 comments on commit f7af77d

Please sign in to comment.