boundless-dialog

THIS IS AN AUTOGENERATED FILE. EDIT INDEX.JS INSTEAD.

Dialog

A non-blocking, focus-stealing container.

A dialog differs from a modal in that it does not come with a masking layer (to obscure the rest of the page) and the user can choose to shift focus away from the dialog contents via mouse click or a keyboard shortcut.

Specific areas (header, body, footer) are defined to provide easy conformance to the [WAI-ARIA spec](http://www.w3.org * /TR/wai-aria/states_and_properties#aria-labelledby) for aria-labelledby and aria-describedby (screen reader * accessibility). Their use is optional, but encouraged.

Props

Note: only top-level props are in the README, for the full list check out the website.

Required Props

There are no required props.

Optional Props

Name	Type	Default Value	Description
after	any renderable	null	arbitrary content to be rendered after the dialog in the DOM
before	any renderable	null	arbitrary content to be rendered before the dialog in the DOM
bodyProps	object	{}	any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-dialog-body` node
captureFocus	bool	true	determines if focus is allowed to move away from the dialog
children	any renderable	null
closeOnEscKey	bool or function	false	enable detection of "Escape" keypresses to trigger `props.onClose`; if a function is provided, the return value determines if the dialog will be closed
closeOnInsideClick	bool or function	false	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
closeOnOutsideClick	bool or function	false	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
closeOnOutsideFocus	bool or function	false	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
closeOnOutsideScroll	bool or function	false	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
footer	any renderable	null	text, ReactElements, etc. comprising the "footer" area of the dialog, e.g. confirm/cancel buttons
footerProps	object	{}	any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-dialog-footer` node
header	any renderable	null	text, ReactElements, etc. to represent the "title bar" area of the dialog
headerProps	object	{}	any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-dialog-header` node
onClose	function	() => {}	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
wrapperProps	object	{}	any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-dialog-wrapper` node