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

Fix the middle dots in the READMEs [skip ci] #34

Merged
merged 1 commit into from
Mar 3, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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 @@ -99,25 +99,25 @@ There are no required props.

### Optional Props

- __`*`__ any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
- __`*`__ · any [React-supported attribute](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`
- __`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
- __`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:
- __`mode`__ · controls which arrow key events are captured to move active focus within the list:

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

### Required Props

- __`children`__ a promise, function that returns a promise, or other type of renderable content; if a function is passed, it will
- __`children`__ · a promise, function that returns a promise, or other type of renderable content; if a function is passed, it will
be called with the current props

Promise example:
Expand Down Expand Up @@ -97,19 +97,19 @@ import { Async } from 'boundless';

### Optional Props

- __`*`__ any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
- __`*`__ · any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

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

- __`childrenDidRender`__ 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
- __`childrenDidRender`__ · 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`__ content to be shown while the promise is in "pending" state (like a loading graphic, perhaps)
- __`pendingContent`__ · content to be shown while the promise is in "pending" state (like a loading graphic, perhaps)

Expects | Default Value
- | -
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 @@ -110,33 +110,33 @@ There are no required props.

### Optional Props

- __`*`__ any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
- __`*`__ · any [React-supported attribute](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 ReactComponent, anything that can be passed as the
- __`component`__ · 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`__ use this callback instead of `onClick` (it's `onClick` + `onKeyDown:Enter`); fires for both button modes
- __`onPressed`__ &middot; use this callback instead of `onClick` (it's `onClick` + `onKeyDown:Enter`); fires for both button modes

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

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

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

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

Expects | Default Value
- | -
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 @@ -147,7 +147,7 @@ import { CheckboxGroup } from 'boundless';

### Required Props

- __`items`__ 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)
- __`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
- | -
Expand All @@ -156,49 +156,49 @@ import { CheckboxGroup } from 'boundless';

### Optional Props

- __`*`__ any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

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

- __`component`__ override the wrapper HTML element if desired
- __`component`__ &middot; override the wrapper HTML element if desired

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

- __`onAllChecked`__ called when all children become checked (not fired on first render), no return
- __`onAllChecked`__ &middot; called when all children become checked (not fired on first render), no return

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

- __`onAllUnchecked`__ called when all children become unchecked (not fired on first render), no return
- __`onAllUnchecked`__ &middot; called when all children become unchecked (not fired on first render), no return

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

- __`onChildChecked`__ called when a specific child has become checked, returns the child definition
- __`onChildChecked`__ &middot; called when a specific child has become checked, returns the child definition

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

- __`onChildUnchecked`__ called when a specific child has become checked, returns the child definition
- __`onChildUnchecked`__ &middot; called when a specific child has become checked, returns the child definition

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

- __`selectAll`__ renders a master checkbox that can manipulate the values of all children simultaneously
- __`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`__ must conform to the [Checkbox prop spec](./Checkbox)
- __`selectAllProps`__ &middot; must conform to the [Checkbox prop spec](./Checkbox)

Expects | Default Value
- | -
Expand Down
12 changes: 6 additions & 6 deletions packages/boundless-checkbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,19 +92,19 @@ There are no required props.

### Optional Props

- __`*`__ any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

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

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

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

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

Expects | Default Value
- | -
Expand All @@ -113,7 +113,7 @@ There are no required props.
indeterminate: false,
}`

- __`label`__ any React-renderable content, most commonly a simple string
- __`label`__ &middot; any React-renderable content, most commonly a simple string

Expects | Default Value
- | -
Expand All @@ -125,13 +125,13 @@ There are no required props.
- | -
`object` | `{}`

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

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

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

Expects | Default Value
- | -
Expand Down
24 changes: 12 additions & 12 deletions packages/boundless-dialog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,72 +109,72 @@ There are no required props.

### Optional Props

- __`*`__ any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

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

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

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

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

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

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

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

- __`closeOnEscKey`__ enable detection of "Escape" keypresses to trigger `props.onClose`; if a function is provided, the return
- __`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`__ enable detection of clicks inside the dialog area to trigger `props.onClose`; if a function is provided, the return
- __`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`__ enable detection of clicks outside the dialog area to trigger `props.onClose`; if a function is provided, the return
- __`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`__ enable detection of focus outside the dialog area to trigger `props.onClose`; if a function is provided, the return
- __`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`__ enable detection of scroll and mousewheel events outside the dialog area to trigger `props.onClose`; if a functio
- __`closeOnOutsideScroll`__ &middot; enable detection of scroll and mousewheel events outside the dialog area to trigger `props.onClose`; if a functio
is provided, the return value determines if the dialog will be closed

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

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

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

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

Expects | Default Value
- | -
Expand All @@ -186,7 +186,7 @@ There are no required props.
- | -
`object` | `{}`

- __`onClose`__ 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
- __`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
- | -
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 @@ -69,19 +69,19 @@ There are no required props.

### Optional Props

- __`*`__ any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

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

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

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

- __`upscale`__ controls if FittedText will automatically scale up the content to fit the available space; normally the component
- __`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
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 @@ -98,7 +98,7 @@ import { Image } from 'boundless';

### Required Props

- __`src`__ a valid path to the desired image
- __`src`__ &middot; a valid path to the desired image

Expects | Default Value
- | -
Expand All @@ -107,19 +107,19 @@ import { Image } from 'boundless';

### Optional Props

- __`*`__ any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

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

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

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

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

Expects | Default Value
- | -
Expand Down
6 changes: 3 additions & 3 deletions packages/boundless-input/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,19 +101,19 @@ There are no required props.

### Optional Props

- __`*`__ any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)
- __`*`__ &middot; any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes)

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

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

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

- __`hidePlaceholderOnFocus`__ triggers the placeholder to disappear when the input field is focused, reappears when the user has tabbed away or focus is moved
- __`hidePlaceholderOnFocus`__ &middot; triggers the placeholder to disappear when the input field is focused, reappears when the user has tabbed away or focus is moved

Expects | Default Value
- | -
Expand Down
Loading