functions.php | ||
README.md | ||
screenshot.jpg | ||
script.js | ||
style.css |
Avada Accessible Child Theme
This child theme enhances the accessibility features of the Avada Wordpress theme by introducing custom options to improve focus outlines and external link accessibility. It aims to provide a more inclusive web experience for users who rely on keyboard navigation and screen readers.
Features
Focus Accessibility
-
Focus Outline Style
- Description: Customize the style of the focus outline for better visibility.
- Options: Solid, Dashed, Dotted, Double, None
- Default: Solid
-
Focus Outline Width
- Description: Set the width of the focus outline in pixels.
- Input: Text field (numeric values in px)
- Default: 2px
-
Focus Outline Color
- Description: Select the color of the focus outline.
- Input: Color picker
- Default: #000000 (Black)
-
Focus Outline Offset
- Description: Enter the offset of the outline in pixels.
- Input: Text field (numeric values in px)
- Default: 1px
-
Focus Trigger
- Description: Choose whether to enable focus outlines only for keyboard navigation or for both mouse clicks and keyboard navigation.
- Options: Keyboard Focus Only, Both Mouse Click and Keyboard Tab Focus
- Default: Keyboard Focus Only
External Link Accessibility
-
External URL Example Text
- Description: Provide example text for external URLs to indicate they open in a new tab.
- Input: Text field
- Default: Open in new tab
-
External Link Accessible Text
- Description: Select how the accessible text for external links should be added.
- Options: As
sr-only
text, Asaria-label
text - Default: As
sr-only
text
-
Show Accessible Text as Tooltip
- Description: Choose whether to display the accessible text for external links as a tooltip. This option is available only when
sr-only
text is selected. - Options: Yes, No
- Default: No
- Description: Choose whether to display the accessible text for external links as a tooltip. This option is available only when
Modal Pop-Up Accessibility
- Added all missing accessbility attribute to modal element, such as 'role': 'button', 'aria-haspopup':'dialog' to modal link/button and 'aria-modal': 'true' to modal pop-up window.
- Open modal pop-up using Space key
- Return focus to to the element that invoked the dialog
- Fixed: modal pop-up scroll to top issue for mobile devices
Note: These all above modal pop-up accessbility doesn't require any configuration from Theme option, its auto enable after enable this child theme.
Installation
-
Download and Install Avada Theme
- Ensure you have the Avada theme installed and activated on your WordPress site.
-
Download and Install the Avada Accessible Child Theme
- Clone or download this repository.
- Upload the child theme to your WordPress site via the WordPress admin dashboard or using FTP.
- Activate the Avada Accessible Child Theme from the Appearance > Themes section.
- Also change the 'CSS Compiling Method' from Appearance > Theme Options > Performance > Dynamic CSS & JS > CSS Compiling Method to Database.
Usage
-
Customize Accessibility Options
- Navigate to Avada > Theme Options > Accessibility Options.
- Configure the focus outline styles and external link accessibility settings as per your requirements.
-
Focus Outline Customization
- Choose the desired outline style, width, and color.
- Select the focus trigger option to specify if the outline should appear for keyboard focus only or both keyboard and mouse interactions.
-
External Link Accessibility Customization
- Enter example text for external URLs.
- Choose whether the accessible text should be added as
sr-only
oraria-label
. - If
sr-only
is selected, decide whether to show the text as a tooltip.
Contribution
We welcome contributions to enhance this child theme. Please follow these steps:
- Fork the Repository
- Create a New Branch (
feature/your-feature-name
) - Commit Your Changes
- Push to the Branch
- Create a Pull Request
License
This project is licensed under the MIT License.
Acknowledgements
Support
If you encounter any issues or have questions, please open an issue on GitHub.
Thank you for using the Avada Accessible Child Theme! We hope this theme helps improve the accessibility of your website.