7.0.0

Version 7 of a11y-dialog aims at reducing complexity, both in terms of implementation, but also in terms of usage.

It is not backward compatible with version 6 (hence the major version bump). The update should not be overly difficult, but requires development work. Read the migration guide.

• [Breaking] Drop support for the native <dialog> element (and the open HTML attribute). It is inconsistent, and already actively discouraged in the documentation. There is a lot of logic around supporting its side-effects which we would be better off. (#158, #163)

• [Breaking] Use aria-modal="true" to no longer make the main content container(s) inert with aria-hidden="true". This significantly reduces the markup expectations and limit the risks of passing the incorrect main content container(s) to the library since it no longer needs them. (#155, #164)

As a result, using a11y-dialog should become significantly easier, and the script size dropped ~20% (now around 1.3Kb).

7.0.0-rc.1

Version 7 of a11y-dialog aims at reducing complexity, both in terms of implementation, but also in terms of usage.

It is not backward compatible with version 6 (hence the major version bump). The update should not be overly difficult, but requires development work. Read the migration guide.

• [Breaking] Drop support for the native <dialog> element (and the open HTML attribute). It is inconsistent, and already actively discouraged in the documentation. There is a lot of logic around supporting its side-effects which we would be better off. (#158, #163)

• [Breaking] Use aria-modal="true" to no longer make the main content container(s) inert with aria-hidden="true". This significantly reduces the markup expectations and limit the risks of passing the incorrect main content container(s) to the library since it no longer needs them. (#155, #164)

As a result, using a11y-dialog should become significantly easier, and the script size dropped ~20% (now around 1.3Kb).

6.1.0

• Fix minor issues when querying focusable elements (#156)
• Improve instructions regarding CDN usage (#154)
• Add documentation about locking window scroll (#153)
• Simplify a JavaScript expression (2cc152f)
• Update author’s name (e94c7d4)
• Move documentation to Docusaurus (tree/documentation, #161, 1813b77, ab4c795, 04de7f3)
• Move example to CodeSandbox (cc22140, 580a284, c05e45e)

6.0.1

• Prevent potential issue with this._listeners being undefined in .off method (#148)

6.0.0

In theory, v6.0.0 should be entirely backward compatible with the latest version from v5. However since the move to Rollup could have unintended side-effect, we’re leaning on the safe side and bumping the major. If you are experiencing any issue with v6, please kindly report them.

Package

• Add support for nested dialogs (#141)
• Move bundling to Rollup (#133)
• Use focusable-selectors to get focusable elements (#134, #143)
• Package an ESM version of the script for CDN usage (#133)
• Move dist files in a dedicated folder, leaving only the source file at the root (#133)
• Move the repository over to KittyGiraudel/a11y-dialog instead of edenspiekermann/a11y-dialog (#138)

Documentation

• Improve the documentation about the expected HTML structure (#137)
• Add a warning about using <dialog> in the documentation (#137)
• Update installation instructions to mention ESM and CDNs (#139, #140)

Tests

• Move testing from Mocha to Cypress (#129)
• Run tests on CI (#130)
• Clean up examples (#142)

5.5.2

• Prevent an issue on some CI with a function being declared within a condition (61069a4)

5.5.1

• Prevent a DOM error when ‘data-a11y-dialog’ has no value (30a8c2f)
• Apply minor improvement to the documentation (b3f6856)

5.5.0

• Provide a way to automatically instantiate dialogs through the DOM API to make it possible to use the library without writing any JavaScript (#128)

5.4.3

• Update development dependencies (a1e21de, ec13ef5, 7c1ce97, 6b1e50a, 3b5ccb2)
• Rename master to main (9718f2a)
• Update author’s name (e0d3980)

5.4.2

• Updates type definition (#123, by @morkro)