Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davidtheclark/react-aria-modal

A fully accessible React modal built according WAI-ARIA Authoring Practices
https://github.com/davidtheclark/react-aria-modal

Last synced: 7 days ago
JSON representation

A fully accessible React modal built according WAI-ARIA Authoring Practices

Awesome Lists containing this project

README 

        
# react-aria-modal



---



**SEEKING CO-MAINTAINERS!** Continued development of this project is going to require the work of one or more dedicated co-maintainers (or forkers). If you're interested, please comment in [this issue](https://github.com/davidtheclark/react-aria-modal/issues/90).



---



A fully accessible and flexible React modal built according [WAI-ARIA Authoring Practices](http://www.w3.org/TR/wai-aria-practices/#dialog_modal).



This module provides a minimally styled "[container](https://medium.com/@dan_abramov/smart-and-dumb-components-7ca2f9a7c7d0)" component to wrap your fully-styled "presentational" component. It provides the following features, while giving you complete control of the content:



  - Focus is trapped within the modal: Tab and Shift+Tab will cycle through the modal's focusable nodes

  without returning to the main document beneath.

  - Escape will close the modal.

  - Scrolling is frozen on the main document beneath the modal.

  - When the modal closes, focus returns to the element that was focused just before the modal activated.

  - The dialog element has an ARIA `role` of `dialog` (or `alertdialog`).

  - The dialog element has an ARIA attribute designating its title, either `aria-label` or `aria-labelledby`.

  - By default, clicking on the modal's underlay (outside the dialog element) will close the modal (this can be disabled).

  - The modal is appended to the end of `document.body` instead of its taking up its source-order position within the React component tree.



"Flexible" mostly means that this module provides absolutely minimal inline styles — just enough to get the thing working — but does not provide "complete" modal styling that would get in your way. You get to (have to) style the dialog yourself. (Maybe make a fancy-looking modal module that others could use, which depends on this one behind the scenes?)



[Check out the demo.](http://davidtheclark.github.io/react-aria-modal/demo/)



## Project Goals



- Full accessibility

- Maximum flexibility

- Absolutely minimal styling

- Modular construction: this module is built on top of a few small JS modules that could be used by other React and non-React frontend components:

  - [focus-trap](https://github.com/davidtheclark/focus-trap), via [focus-trap-react](https://github.com/davidtheclark/focus-trap-react)

  - [no-scroll](https://github.com/davidtheclark/no-scroll)

  - [react-displace](https://github.com/davidtheclark/react-displace)



**If you like this kind of module (accessible, flexible, unstyled) you should also check out these projects:**

- [react-aria-menubutton](https://github.com/davidtheclark/react-aria-menubutton)

- [react-aria-tabpanel](https://github.com/davidtheclark/react-aria-tabpanel)



## Installation



```

npm install react-aria-modal

```



`dist/react-aria-modal.js` is the Babel-compiled file that you'll use.



### React Dependency



Version 2+ is compatible with React >0.14.



Version 1+ is compatible with React 0.13.



## Usage



Just provide the right props (see below) and pass the content of the modal as this component's child.



Look in [`demo/js/`](demo/js/) for examples and [view the demo](http://davidtheclark.github.io/react-aria-modal/demo/), but here's a simple example:



```jsx

const React = require('react');

const ReactDOM = require('react-dom');

const AriaModal = require('../../');



class DemoOne extends React.Component {

  constructor(props) {

    super(props);



    this.state = {

      modalActive: false

    };



    this.activateModal = this.activateModal.bind(this);

    this.deactivateModal = this.deactivateModal.bind(this);

    this.getApplicationNode = this.getApplicationNode.bind(this);

  }



  activateModal = () => {

    this.setState({ modalActive: true });

  };



  deactivateModal = () => {

    this.setState({ modalActive: false });

  };



  getApplicationNode = () => {

    return document.getElementById('application');

  };



  render() {

    const modal = this.state.modalActive

      ? 

          


            


              


                Here is a modal

                {' '}

                with

                {' '}

                some

                {' '}

                focusable

                {' '}

                parts.

              


            


            

              

                deactivate modal

              

            

          


        

      : false;



    return (

      


        

          activate modal

        

        {modal}

      


    );

  }

}



ReactDOM.render(, document.getElementById('demo-one'));

```



## Details



The modal can be activated in a couple of ways:

- mounting the component *without* an `mounted` prop

- passing `true` as the `mounted` prop



Similarly, the modal can be deactivated in a couple of ways:

- unmounting the component

- passing `false` as the `mounted` prop



Pass your dialog element as the child. And that's it.



When the modal is mounted, you'll notice the following:

- Focus is trapped: only elements within the modal will receive focus as you tab through. This is done by [focus-trap](https://github.com/davidtheclark/focus-trap), via [focus-trap-react](https://github.com/davidtheclark/focus-trap-react).

- The modal has the ARIA attributes it needs: a `role` of `dialog` (or `alertdialog`) and an `aria-label` or `aria-labelledby` attribute.

- The main document's scroll is frozen (except on touchscreens). This is done by [no-scroll](https://github.com/davidtheclark/no-scroll).

- Your content is set atop a fixed-position underlay. You can control the appearance and behavior of this underlay in various ways (see below).

- Your content is horizontally centered. You can also vertically center it, if you wish.

- The modal is appended to `document.body`, not inserted directly into the HTML source order, as you might assume; but it should still update correctly. (This makes positioning easier (no weird nested z-index troubles).)



## API

|Name| Type (`Default`) |

|---|---|

| [alert](#alert) | `Boolean` |

| [applicationNode](#applicationNode) | `DOM Node` |

| [dialogClass](#dialogClass) | `String` |

| [dialogId](#dialogId) | `String` (`'react-aria-modal-dialog'`) |

| [dialogStyle](#dialogStyle) | `Object` |

| [escapeExits](#escapeExits) | `Boolean` (`true`) |

| [focusDialog](#focusDialog) | `Boolean` |

| [focusTrapOptions](#focusTrapOptions) | `Object` |

| [focusTrapPaused](#focusTrapPaused) | `Boolean` |

| [getApplicationNode](#getApplicationNode) | `() => void` |

| [includeDefaultStyles](#includeDefaultStyles) | `Boolean` (`true`) |

| [initialFocus](#initialFocus) | `String` |

| [mounted](#mounted) | `Boolean` |

| [onEnter](#onEnter) | `() => void` |

| [onExit](#onExit) | `(event) => void` |

| [scrollDisabled](#scrollDisabled) | `Boolean` (`true`) |

| [titleId](#titleId) | `String` |

| [titleText](#titleText) | `String` |

| [underlayClass](#underlayClass) | `String` |

| [underlayClickExits](#underlayClickExits) | `Boolean` (`true`) |

| [underlayColor](#underlayColor) | `String` (`'rgba(0,0,0,0.5)'`) |

| [underlayStyle](#underlayStyle) | `Object` |

| [verticallyCenter](#verticallyCenter) | `Boolean` |



## Reference API



Any `data-*` or `aria-*` props that you provide will be passed directly to the modal's container `
`.



### alert



_Type_: `Boolean`



If `true`, the modal will receive a `role` of `alertdialog`, instead of its default `dialog`. The `alertdialog` role should only be used when an alert, error, or warning occurs ([more info](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_alertdialog_role)).



### applicationNode



_Type_: `DOM Node`



Provide your main application node here (which the modal should render outside of), and when the modal is open this application node will receive the attribute `aria-hidden="true"`. This [can help screen readers understand what's going on](https://www.w3.org/WAI/GL/wiki/Using_ARIA_role%3Ddialog_to_implement_a_modal_dialog_box#Description).



This module can't guess your application node, so you have to provide this prop to get the full accessibility benefit.



### dialogClass



_Type_: `String`



Apply a class to the dialog in order to custom-style it.



Be aware that, *by default*, this module does apply various inline styles to the dialog element in order position it. To disable *all inline styles*, see `includeDefaultStyles`.



### dialogId



_Type_: `String`



_Default_: `react-aria-modal-dialog`



Choose your own id attribute for the dialog element.



### dialogStyle



_Type_: `Object`



Customize properties of the `style` prop that is passed to the dialog.



### escapeExits



_Type_: `Boolean`



_Default_: `true`



By default, the Escape key exits the modal. Pass `false`, and it won't.



### focusDialog



_Type_: `Boolean`



By default, when the modal activates its first focusable child will receive focus.

However, if `focusDialog` is `true`, the dialog itself will receive initial focus —

and that focus will be hidden. (This is essentially what Bootstrap does with their modal.)



See the example below.



### focusTrapOptions



_Type_: `Object`



Customize properties of the `focusTrapOptions` prop that is passed to the modal dialog's [focus trap](https://github.com/davidtheclark/focus-trap).

For example, you can use this prop if you need better control of where focus is returned.



### focusTrapPaused



_Type_: `Boolean`



If `true`, the modal dialog's [focus trap](https://github.com/davidtheclark/focus-trap) will be paused.



You won't typically need to use this prop.

It used to be that the typical reason for pausing a focus trap was to enable *nested* focus traps; but as of [focus-trap v4](https://github.com/davidtheclark/focus-trap/blob/master/CHANGELOG.md#400), the pausing and unpausing of hierachical traps is handled automatically.



### getApplicationNode



_Type_: `() => void`



Same as `applicationNode`, but a function that returns the node instead of the node itself. This can be useful or necessary in a variety of situations, one of which is server-side React rendering. The function will not be called until after the component mounts, so it is safe to use browser globals and refer to DOM nodes within it (e.g. `document.getElementById(..)`), without ruining your server-side rendering.



### includeDefaultStyles



_Type_: `Boolean`



_Default_: `true`



By default, styles are applied inline to the  dialog and underlay portions of the component.  However, you can disable all inline styles by setting `includeDefaultStyles` to `false`.  If set, *you must specify all styles externally*, including positioning.  This is helpful if your project uses external CSS assets.



*Note:* `underlayStyle` and `dialogStyle` can still be set inline, but these will be the only styles applied.



### initialFocus



_Type_: `String`



By default, when the modal activates its first focusable child will receive focus. If, instead, you want to *identify a specific element that should receive initial focus*, pass a *selector string* to this prop. (That selector is passed to `document.querySelector()` to find the DOM node.)



Demo example 3 and an additional example below illustrate a good method if you want no initial visible focus. (Add `tabIndex='0'` to the modal's content and give it `outline: 0;`.)



### mounted



_Type_: `Boolean`



By default, the modal is active when mounted, deactivated when unmounted.

However, you can also control its active/inactive state by changing its `mounted` property instead.



The following two examples are near-equivalents — the first mounts and unmounts, while the second changes the `mounted` prop:



```jsx

var MyComponent = React.createClass({

  ..

  render: function() {

    ..

    var modal = (this.state.modalActive) ? (

      

        {modalContents}

      

    ) : false;

    return 
{modal}
;

  },

});



var MyComponentTakeTwo = React.createClass({

  ..

  render: function() {

    ..

    return (

      


        

          {modalContents}

        

      


    );

  },

});

```



### onEnter



_Type_: `() => void`



This function is called in the modal's `componentDidMount()` lifecycle method.

You can use it to do whatever diverse and sundry things you feel like doing after the modal activates.



Demo Five, for example, uses it to modify class names and enable some CSS transitions.



### onExit



_Type_: `(event) => void`



This function handles the state change of *exiting* (or deactivating) the modal.

It will be invoked when the user clicks outside the modal (if `underlayClickExits={true}`, as is the default) or hits Escape (if `escapeExits={true}`, as is the default), and it receives the event that triggered it as its only argument.



Maybe it's just a wrapper around `setState()`; or maybe you use some more involved Flux-inspired state management — whatever the case, this module leaves the state management up to *you* instead of making assumptions. That also makes it easier to create your own "close modal" buttons; because you have the function that closes the modal right there, written by you, at your disposal.



You may omit this prop if you don't want clicks outside the modal or Escape to close it, so don't want to provide a function.



### scrollDisabled



_Type_: `Boolean`



_Default_: `true`



If `true`, the modal dialog will prevent any scrolling behind the modal window.



### titleId



_Type_: `String`



The id of the element that should be used as the modal's accessible title. This value is passed to the modal's `aria-labelledby` attribute.



You must use either `titleId` or `titleText`, but not both.



### titleText



_Type_: `String`



A string to use as the modal's accessible title. This value is passed to the modal's `aria-label` attribute.



You must use either `titleId` or `titleText`, but not both.



### underlayClass



_Type_: `String`



Apply a class to the underlay in order to custom-style it.



This module does apply various inline styles, though, so be aware that overriding some styles might be difficult. If, for example, you want to change the underlay's color, you should probably use the `underlayColor` prop instead of a class. If you would rather control *all CSS*, see `includeDefaultStyles`.



### underlayClickExits



_Type_: `Boolean`



_Default_: `true`



By default, a click on the underlay will exit the modal. Pass `false`, and clicking on the underlay will do nothing.



### underlayColor



_Type_: `String` (color value) or `false`



_Default_: `rgba(0,0,0,0.5)`



If you want to change the underlay's color, you can do that with this prop.



If `false`, no background color will be applied with inline styles.

Presumably you will apply then yourself via an `underlayClass`.



### underlayStyle



_Type_: `Object`



Customize properties of the `style` prop that is passed to the underlay.



**The best way to add some vertical displacement to the dialog is to add top & bottom padding to the underlay**. This is illustrated in the demo examples.



### verticallyCenter



_Type_: `Boolean`



If `true`, the modal's contents will be vertically (as well as horizontally) centered.



## AriaModal.renderTo(HTMLElement | string)



react-aria-modal uses [react-displace](https://github.com/davidtheclark/react-displace) to insert the modal into a new element at the end of ``, making it easier to deal with positioning and z-indexes.



The static `renderTo` function returns *a new component* that renders modals into a specific element, rather than a newly created element at the bottom of the page.



Strings are used as selectors, passed to `querySelector`.



See demo six for an example.



## More examples



An alert dialog that itself receives initial focus (but has no visible outline) and does not exit when the underlay is clicked, and is vertically centered:



```jsx

var AriaModal = require('react-aria-modal');



var MyModal = React.createClass({

  ..

  render: function() {

    return (

      

        


          
Alert!


          ..

        


      

    )

  }

})

```



## Contributing & Development



Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.



Lint with `npm run lint`.



Test the demos with `npm start`.



Build with `npm build`.