Skip to content

Commit

Permalink
Updating the name to Bare Modal
Browse files Browse the repository at this point in the history
  • Loading branch information
millertchris committed Feb 29, 2024
1 parent 5e75070 commit ce5dd3c
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 20 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Accessible Modal
# Bare Modal

Accessible Modal is a lightweight, accessible modal library designed to enhance user interaction on web applications. Utilizing the native HTML `<dialog>` element, it offers an easy and robust solution for implementing modals with features like automatic action binding, cookie-based user action tracking, customizable cookie durations, and timed modal displays.
Bare Modal is a lightweight, accessible modal library designed to enhance user interaction on web applications. Utilizing the native HTML `<dialog>` element, it offers an easy and robust solution for implementing modals with features like automatic action binding, cookie-based user action tracking, customizable cookie durations, and timed modal displays.

## Features

Expand All @@ -13,10 +13,10 @@ Accessible Modal is a lightweight, accessible modal library designed to enhance

## Installation

Include Accessible Modal in your project by adding the `Accessible Modal.js` file to your codebase and linking to it within your HTML file:
Include Bare Modal in your project by adding the `bare-modal.min.js` file to your codebase and linking to it within your HTML file:

```html
<script src="path/to/Accessible Modal.js"></script>
<script src="path/to/bare-modal.min.js"></script>
```

## Usage
Expand Down Expand Up @@ -78,7 +78,7 @@ Sets the duration for which the user's action on the modal is remembered.

## Accessibility

Accessible Modal leverages the `<dialog>` element's inherent accessibility features, such as focus management and semantic structure. It adheres to WCAG guidelines, ensuring that modals are accessible to all users, including those using assistive technologies.
Bare Modal leverages the `<dialog>` element's inherent accessibility features, such as focus management and semantic structure. It adheres to WCAG guidelines, ensuring that modals are accessible to all users, including those using assistive technologies.

## Best Practices

Expand All @@ -88,8 +88,8 @@ Accessible Modal leverages the `<dialog>` element's inherent accessibility featu

## Contributing

Contributions are welcome! If you have suggestions for improving Accessible Modal, please open an issue or submit a pull request.
Contributions are welcome! If you have suggestions for improving Bare Modal, please open an issue or submit a pull request.

## License

Accessible Modal is open-source software licensed under the MIT license.
Bare Modal is open-source software licensed under the MIT license.
1 change: 0 additions & 1 deletion dist/accessible-modal.min.js

This file was deleted.

1 change: 1 addition & 0 deletions dist/bare-modal.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 7 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@
{
"name": "accessible-modal",
"name": "bare-modal",
"version": "1.0.0",
"description": "Accessible Modal is a lightweight JS library using the native `<dialog>` HTML tag. Features automatic bindings, cookie tracking, timed displays, and WCAG compliance for enhanced user engagement and accessibility.",
"description": "Bare Modal is a lightweight JS library using the native `<dialog>` HTML tag. Features automatic bindings, cookie tracking, timed displays, and WCAG compliance for enhanced user engagement and accessibility.",
"main": "src/index.js",
"scripts": {
"build": "terser src/index.js -o dist/accessible-modal.min.js -c -m",
"build": "terser src/index.js -o dist/bare-modal.min.js -c -m",
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/prolific-digital/accessible-modal.git"
"url": "git+https://github.com/prolific-digital/bare-modal.git"
},
"keywords": [
"javascript",
"html5",
"native",
"bare",
"accessibility",
"modal",
"easy-to-use"
],
"author": "Chris Miller, Jeff Gullett",
"license": "MIT",
"bugs": {
"url": "https://github.com/prolific-digital/accessible-modal/issues"
"url": "https://github.com/prolific-digital/bare-modal/issues"
},
"homepage": "https://github.com/prolific-digital/accessible-modal#readme",
"homepage": "https://github.com/prolific-digital/bare-modal#readme",
"devDependencies": {
"terser": "^5.28.1"
}
Expand Down
8 changes: 4 additions & 4 deletions src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Accessible Modal Examples</title>
<title>Bare Modal Examples</title>
</head>
<body>
<h2>Accessible Modal Examples</h2>
<h2>Bare Modal Examples</h2>

<button data-modal-trigger="actionModal">Open Action Modal</button>

Expand Down Expand Up @@ -35,9 +35,9 @@ <h2>Accessible Modal Examples</h2>
<button data-modal-cancel>Cancel</button>
</dialog>

<script src="../dist/accessible-modal.min.js"></script>
<script src="../dist/bare-modal.min.js"></script>
<script>
new AccessibleModal();
new BareModal();
</script>
</body>
</html>
4 changes: 2 additions & 2 deletions src/index.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* Enhanced AccessibleModal class with support for remembering user actions through cookies,
* Enhanced BareModal class with support for remembering user actions through cookies,
* customizable cookie duration, and automatic timed modal display.
*/
class AccessibleModal {
class BareModal {
constructor() {
// Initialize modals once the DOM is fully loaded.
document.addEventListener('DOMContentLoaded', () => {
Expand Down

0 comments on commit ce5dd3c

Please sign in to comment.