Essential CSS
JavaScript Roadmap
Learn JavaScript
Mastering Web Typography
Practical Astro
Understanding Async JS
Unorthodox Tailwind
API Masterclass
Build and Deploy
The Beginner Freelancer
Real World Node
Profile Billing Logout
Learn JavaScript
Lesson Plan
  1. JavaScript and its ecosystem
    1. Welcome to Learn JavaScript!
    2. What is JavaScript used for?
    3. The JavaScript ecosystem
    4. Varying versions of JavaScript
  2. JS Basics
    1. Linking your JavaScript file
    2. Preparing your text editor
    3. The Console
    4. Comments
    5. On semicolons
    6. Strings, numbers and booleans
    7. Understanding Variables
    8. Understanding Functions
    9. The Flow of a Function
    10. Arrow functions
    11. Intro to objects
    12. If/else statements
    13. Comparing Objects
    14. The NOT operator
    15. Null and Undefined
    16. The BOM and the DOM
    17. Selecting an Element
    18. Changing Classes
    19. Listening to events
    20. Callbacks
  3. Building simple components
    1. How to think like a developer
    2. Starter files and Source codes
    3. Do this for every component
    4. 🛠 Off-canvas menu: Building an off-canvas menu
    5. 🛠 Modal: Building a Modal
    6. Lessons from the building process
    7. Debugging errors
    8. How to use a linter
  4. Arrays and loops
    1. Introduction to Arrays
    2. Array methods
    3. For loops
    4. The forEach loop
    5. Selecting multiple elements
    6. Nodes vs Elements
    7. 🛠 Accordion: Building an accordion
  5. Dom basics
    1. Id, classes, attributes, and tags
    2. Changing CSS with JavaScript
    3. Getting CSS with JavaScript
    4. Changing Attributes
    5. Finding an element's size and position
    6. DOM Traversals
    7. 🛠 Tabby: Building Tabby (A Tabbed component)
    8. 🛠 Carousel: HTML and CSS
    9. 🛠 Carousel: Switching slides with JavaScript
    10. 🛠 Carousel: Working the dots
    11. 🛠 Carousel: Positioning slides with JavaScript
  6. Events deep dive
    1. The listening element
    2. Default Behaviors
    3. Event propagation
    4. Event delegation
    5. Removing Event Listeners
    6. 🛠 Modal: Closing the modal
    7. 🛠 Accordion: Event delegation
    8. 🛠 Tabby: Event delegation
    9. 🛠 Carousel: Event delegation
  7. Transitions and Animations
    1. CSS Transitions
    2. CSS Animations
    3. Silky-smooth animations
    4. Integrating CSS transitions and animations with JavaScript
    5. Animating with JavaScript
    6. GreenSock Animation API (GSAP)
    7. 🛠 Off-canvas menu: Animations
    8. 🛠 Modal: Animating the modal
    9. 🛠 Modal: Animating the pointing hand
    10. 🛠 Modal: Animating the waving hand
    11. 🛠 Modal: Wave hand animation with JavaScript (using GSAP)
    12. 🛠 Accordion: Animations
    13. 🛠 Carousel: Animations
  8. Useful JS features
    1. Ternary operators
    2. AND and OR operators
    3. Early returns
    4. Template Literals
    5. Destructuring
    6. Default parameters
    7. Enhanced Object Literals
    8. Rest and Spread
    9. Useful array methods
    10. Looping through objects
    11. Returning objects with implicit return
    12. 🛠 Accordion: Using useful JavaScript features
    13. 🛠 Tabby: Using useful JavaScript features
    14. 🛠 Carousel: Useful JavaScript features
  9. JS Best practices
    1. Write declarative code
    2. Functions with a purpose
    3. Manage scope
    4. Reduce state changes
    5. Don't reassign
    6. Don't mutate
    7. Preventing Objects from mutating
    8. Preventing Arrays from mutating
    9. Write pure functions
    10. 🛠 Accordion: Refactor
    11. 🛠 Carousel: First refactor
    12. 🛠 Carousel: Refactoring the dots part
    13. 🛠 Carousel: Previous and next buttons
    14. 🛠 Carousel: Second refactor
  10. Manipulating text and content
    1. Changing Text and HTML
    2. Creating HTML Elements
    3. Adding multiple elements to the DOM
    4. Removing Elements from the DOM
    5. 🛠 Carousel: Creating dots with JavaScript
    6. 🛠️ Calculator: HTML and CSS
    7. 🛠️ Calculator: Happy Path
    8. 🛠️ Calculator: Testing the Happy Path
    9. 🛠️ Calculator: Easy Edge Cases
    10. 🛠️ Calculator: Difficult Edge Cases
    11. 🛠️ Calculator: Refactoring
    12. The switch statement
    13. 🛠️ Calculator: Refactoring (Part 2)
    14. 🛠️ Popover: Making one popover
    15. 🛠️ Popover: Making four popovers
    16. 🛠️ Popover: Making popovers with JavaScript
  11. Handling Forms
    1. Intro to forms
    2. Selecting form fields with JavaScript
    3. Form fields and their events
    4. Sanitize your output
    5. Generating unique IDs
    6. 🛠️ Popover: Dynamic ID
    7. 🛠️ Todolist: The HTML and CSS
    8. 🛠️ Todolist: Creating tasks with JavaScript
    9. 🛠️ Todolist: Deleting tasks with JavaScript
    10. 🛠️ Typeahead: The HTML and CSS
    11. 🛠️ Typeahead: Displaying predictions
    12. 🛠️ Typeahead: Selecting a prediction
    13. 🛠️ Typeahead: Bolding search terms
  12. Handling Dates
    1. The Date object
    2. Getting a formatted date
    3. Getting the time
    4. Local time and UTC Time
    5. Setting a specific date
    6. Setting a date with Date methods
    7. Adding (or subtracting) date and time
    8. Comparing Dates and times
    9. 🛠️ Datepicker: HTML and CSS
    10. 🛠️ Datepicker: Building the calendar
    11. 🛠️ Datepicker: Building the datepicker with JavaScript
    12. 🛠️ Datepicker: Previous and Next buttons
    13. 🛠️ Datepicker: Selecting a date
    14. 🛠️ Datepicker: Positioning the datepicker
    15. 🛠️ Datepicker: Showing and hiding
    16. Formatting a date with toLocaleString
    17. setTimeout
    18. setInterval
    19. 🛠️ Countdown timer: HTML and CSS
    20. 🛠️ Countdown timer: JavaScript
    21. 🛠️ Countdown timer: Counting Months
    22. 🛠️ Countdown timer: Daylight Saving Time
    23. 🛠️ Countdown timer: Counting Years
  13. Async JS
    1. Introduction to Ajax
    2. Understanding JSON
    3. The Fetch API
    4. Possible data types
    5. JavaScript Promises
    6. Requests and responses
    7. Sending a POST request
    8. Authentication
    9. Handling errors
    10. Viewing response headers
    11. CORS and JSONP
    12. XHR vs Fetch
    13. Using an Ajax library
    14. Reading API documentation
    15. Understanding curl
    16. 🛠️ Todolist: The Todolist API
    17. 🛠️ Todolist: Fetching tasks
    18. 🛠️ Todolist: Creating tasks
    19. 🛠️ Todolist: Editing tasks
    20. 🛠️ Todolist: Deleting tasks
    21. 🛠️ Todolist: Creating tasks with Optimistic UI
    22. 🛠️ Todolist: Handling Optimistic UI errors
    23. 🛠️ Todolist: Editing tasks with Optimistic UI
    24. 🛠️ Todolist: Deleting tasks with Optimistic UI
    25. 🛠️ Todolist: Refactor
    26. 🛠️ Typeahead: How to add Ajax
    27. 🛠️ Typeahead: Adding Ajax
    28. 🛠️ Typeahead: Handling errors
    29. 🛠️ Google Maps Clone: Creating your first Google Map
    30. 🛠️ Google Maps Clone: Fetching JSONP via JavaScript
    31. 🛠️ Google Maps Clone: Drawing directions
    32. 🛠️ Google Maps Clone: Driving directions
    33. 🛠️ Google Maps Clone: Handling errors
    34. 🛠️ Google Maps Clone: Adding stopovers
    35. 🛠️ Google Maps Clone: Refactor
  14. Advanced Async JS
    1. Requesting many resources at once
    2. Asynchronous functions
    3. Handling multiple awaits
    4. Asynchronous loops
    5. 🛠️ Dota Heroes: Listing heroes
    6. 🛠️ Dota Heroes: Filtering heroes (Part 1)
    7. 🛠️ Dota Heroes: Filtering heroes (Part 2)
    8. 🛠️ Dota Heroes: Refactoring
    9. 🛠️ Dota Heroes: Hero Page
    10. 🛠️ Dota Heroes: Making the hero page robust
    11. 🛠️ Dota Heroes: Heroes page refactor
  15. Handling Keyboard Events
    1. Keyboard users
    2. Handling commonly used keys
    3. Keyboard events
    4. Understanding Tabindex
    5. Detecting the focused element
    6. Directing focus
    7. Preventing people from tabbing into elements
    8. How to choose keyboard shortcuts
    9. Creating single-key shortcuts
    10. 🛠️ Off-canvas: Adding keyboard interaction
    11. 🛠️ Modal: Adding keyboard interaction
    12. 🛠️ Accordion: Adding keyboard interaction
    13. 🛠️ Tabby: Adding keyboard interaction
    14. 🛠️ Tabby: Refactoring
    15. 🛠️ Carousel: Adding keyboard interaction
    16. 🛠️ Carousel: Displaying help text
    17. 🛠️ Calculator: Adding keyboard interaction
    18. 🛠️ Popover: Keyboard
    19. 🛠️ Popover: Refactor
    20. Keyboard shortcuts with Command and Control modifiers
    21. 🛠️ Todolist: Keyboard
    22. 🛠️ Typeahead: Keyboard
    23. 🛠️ Typeahead: Selecting a prediction with the keyboard
    24. 🛠️ Google Maps Clone: Keyboard
    25. 🛠️ Dota Heroes: Keyboard
    26. 🛠️ Datepicker: Tabbing in and out
    27. 🛠️ Datepicker: Keyboard shortcuts
  16. Screen reader accessibility
    1. What is accessibility?
    2. How to use a screen reader
    3. Using NVDA
    4. Using Voiceover
    5. Aria roles
    6. Landmark roles
    7. Document structure roles
    8. Live region roles
    9. Widget roles
    10. Window and Abstract roles
    11. Accessible names and descriptions
    12. Hiding content
    13. ARIA properties and ARIA states
    14. ARIA for expandable widgets
    15. 🛠️ Off-canvas: Accessibility
    16. ARIA for modal dialogs
    17. 🛠️ Modal: Screen reader accessibility
    18. 🛠️ Accordion: Screen reader accessibility
    19. ARIA for Tabbed components
    20. 🛠️ Tabby: Screen reader accessibility
    21. 🛠️ Tabby: Refactor
    22. 🛠️ Carousel: Screen reader accessibility
    23. Roles that trigger Forms and Application modes
    24. What's next for accessibility?
  17. Handling Scroll
    1. The Scroll event
    2. 🛠️ Auto-hiding Sticky-nav: HTML and CSS
    3. 🛠️ Auto-hiding Sticky-nav: JavaScript
    4. 🛠️ Auto-hiding Sticky-nav: Natural reveal
    5. Intersection Observer API
    6. Intersection Observer Options
    7. 🛠️ Slide & Reveal
    8. 🛠️ Slide & Reveal: Always fade-in when you scroll down
    9. 🛠️ Slide & Reveal: Fine-tuning the animation
    10. 🛠️ Infinite Scroll: Anatomy
    11. 🛠️ Infinite Scroll: Infinite load
    12. 🛠️ Infinite Scroll: Refactor
    13. 🛠️ Infinite Scroll: Implementing the Infinite Scroll
  18. Mouse, Touch, and Pointer events
    1. Mouse Events
    2. 🛠️ Spinning Pacman: HTML and CSS
    3. 🛠️ Spinning Pacman: JavaScript
    4. Touch events
    5. Pointer events
    6. Touch-action
    7. 🛠️ Spinning Pacman: Supporting Touch
    8. Cloning elements
    9. 🛠️ DragDrop: HTML and CSS
    10. 🛠️ DragDrop: JavaScript
    11. 🛠️ DragDrop: Creating a drop preview
    12. 🛠️ DragDrop: Sortable drop preview
    13. 🛠️ DragDrop: Robustness
    14. 🛠️ DragDrop: Refactor
  19. Object Oriented Programming
    1. Before we begin
    2. What is Object Oriented Programming?
    3. Four Flavours of Object Oriented Programming
    4. Inheritance
    5. This in JavaScript
    6. Call, bind, apply
    7. Creating Derivative Objects
    8. Composition vs Inheritance
    9. Polymorphism
    10. Encapsulation
    11. Closures
    12. Encapsulation in Object Oriented Programming
    13. Getters and Setters
    14. What OOP flavour to use
    15. When to use Object Oriented Programming
  20. Writing reusable code
    1. Creating reusable code by writing libraries
    2. Two Types of libraries
    3. Including libraries with Script tags
    4. Including libraries with ES6 Modules
    5. Dynamic imports
    6. 🛠️ Off Canvas: Building a Library
    7. 🛠️ Modal: Library setup
    8. 🛠️ Modal: Opening the Modal
    9. 🛠️ Modal: Closing the modal
    10. 🛠️ Modal: Inheritance and Polymorphism
    11. 🛠️ Modal: Resolving differences between subclasses
    12. 🛠️ Modal: Exposing properties and methods
    13. 🛠️ Accordion: Building a library
    14. 🛠️ Tabby: Building a library
    15. 🛠️ Carousel: Building a library
    16. 🛠️ Calculator: Library
    17. 🛠️ Calculator: Fixing the Clear Key
    18. 🛠️ Calculator: Handling other keys
    19. 🛠️ Calculator: State
    20. 🛠️ Popover: Library
    21. 🛠️ Popover: Adding event listeners
    22. 🛠️ Typeahead: Library
    23. 🛠️ DatePicker: Library
  21. Going from Vanilla JS to JS Frameworks
    1. 🛠️ Building a Tiny framework
    2. 🛠️ Tiny: Add event listeners
    3. 🛠️ Tiny: Updating state
    4. 🛠️ Tiny: Rendering Child Components
    5. 🛠️ Tiny: Changing Parent State
    6. 🛠️ Tiny: Passing Props
    7. 🛠️ Tiny: Multiple Props
    8. 🛠️ Tiny: Passing values from sibling components
    9. 🛠️ Tiny: Mounting
    10. 🛠️ Tiny: Passing props to descendants
    11. 🛠️ Tiny: A tiny refactor
  22. Single Page Apps
    1. What is a Single Page App?
    2. Simple SPA using only CSS
    3. The Location Interface
    4. The History Interface
    5. Minimum viable server for a SPA
    6. 🛠️ Dota SPA: Introduction
    7. 🛠️ Dota SPA: Building The Heroes List
    8. 🛠️ Dota SPA: Building the filters
    9. 🛠️ Dota SPA: Filtering heroes
    10. 🛠️ Dota SPA: Displaying filtered heroes
    11. 🛠️ Dota SPA: Getting Ready to build the Hero Page
    12. 🛠️ Dota SPA: Building the hero page
    13. 🛠️ Dota SPA: Lore and abilities
    14. 🛠️ Dota SPA: Routing for Single-page apps

🛠️ Modal: Opening the Modal

When the user clicks on a button, we need to know which modal to open. We can pass this button and its corresponding modal into Modal.

Main.js
Modal({
modal: document.querySelector('#user-triggered-modal'),
button: document.querySelector('#user-triggered-modal-button'),
})

We can accept these properties via a settings object.

export default function Modal(settings) {
const { button, modal } = settings
}

Writing openModal

To open the modal, we need to add is-open to the modal’s overlay. We can find the overlay from the modal element. (The overlay is the modal’s parent element).

export default function Modal(settings) {
const { button, modal } = settings
const overlay = modal.parentElement
console.log(overlay)
}
Logs the modal overlay into the console.

We need to create an openModal function inside modal.js. There are several ways to create this function:

  1. Creating it outside Modal
  2. Creating it inside Modal
  3. Creating it as a method

There are pros and cons to each approach.

If we create openModal outside Modal, the code will look something like this:

export default function Modal(settings) {
// ...
}
function openModal() {
// ...
}

The downside to this approach is you cannot take advantage of the lexical scope. You have to pass in variables from Modal into openModal.

Example:

export default function Modal(settings) {
// ...
openModal(overlay)
}
function openModal(overlay) {
overlay.classList.add('is-open')
}

If we declare openModal in Modal, we don’t have to pass in any variables. We can rely on the lexical scope.

export default function Modal(settings) {
// ...
function openModal() {
overlay.classList.add('is-open')
}
// Opening the modal
openModal()
}

Although this works, I find it messy to have lots of functions scattered inside another function. I find it easier to read the code when all my functions are placed together in an object, which brings us to the third way: Creating openModal as a method.

export default function Modal(settings) {
// ...
const object = {
openModal() {
overlay.classList.add('is-open')
},
}
// Opening the modal
object.openModal()
}

I prefer to use the component’s name as this object since it’s easier to understand. In this case, it’ll be modal.

export default function Modal(settings) {
// ...
const modal = {
openModal() {
overlay.classList.add('is-open')
},
}
// Opening the modal
modal.openModal()
}

When I do this, I don’t have to write the function as openModal anymore. It’s obvious that I’m opening the modal when I write modal.open. So I can rename openModal to open.

export default function Modal(settings) {
// ...
const modal = {
open() {
overlay.classList.add('is-open')
},
}
// Opening the modal
modal.open()
}

For this to work, I need to rename the modal variable passed via the settings. I like to add Element as a suffix so I know I’m dealing with an element.

export default function Modal(settings) {
const modalElement = settings.modal
// ...
const modal = {
/* ... */
}
}

We can ask the user to pass in modalElement instead of modal to make this process simpler.

main.js
Modal({
modalElement: document.querySelector('#user-triggered-modal'),
buttonElement: document.querySelector('#user-triggered-modal-button'),
})
export default function Modal(settings) {
const { modalElement, buttonElement } = settings
// ...
const modal = {
/* ... */
}
}

We should also rename overlay to overlayElement to follow the naming convention.

export default function Modal(settings) {
const { modalElement, buttonElement } = settings
const overlayElement = modalElement.parentElement
const modal = {
/* ... */
}
}

We’re done with the setup now. And we can focus on the mechanics of opening the modal.

Opening the Modal

We need to open the modal when a user clicks on the button. This means we need an event listener. We can place this event listener inside Modal to make things simple.

export default function Modal(settings) {
// Declare variables
// Declare methods
buttonElement.addEventListener('click', _ => {
modal.open()
})
}

We can ensure open gets called by checking with a console.log statement.

export default function Modal(settings) {
// Declare variables
const modal = {
open() {
console.log('Opening modal')
},
}
// Add event listeners
buttonElement.addEventListener('click', _ => {
modal.open()
})
}

There are six steps to opening the modal:

  1. Adding an opening class
  2. Waving the hand
  3. Focusing on the first element
  4. Trapping focus
  5. Setting aria-expanded to true
  6. Preventing screen readers from reading other elements with aria-hidden.

We can see these six steps clearly from the code we wrote previously.

// Previous code
function openModal() {
document.body.classList.add('modal-is-open')
wave()
const input = modal.querySelector('input')
input.focus()
document.addEventListener('keydown', trapFocus)
modalButton.setAttribute('aria-expanded', true)
main.setAttribute('aria-hidden', 'true')
}

Adding the opening class

In the previous lesson, we agreed to use this HTML pattern:

<div class="modal-overlay">
<div class="modal">...</div>
</div>
<div class="modal-overlay">
<div class="modal">...</div>
</div>

This means we need to add is-open to the overlay to open the modal.

export default function Modal(settings) {
// Declare variables
const modal = {
open() {
overlayElement.classList.add('is-open')
},
}
// Add event listeners
}

The modal should appear when you click the button.

Modal Appears.

Waving the hand

We called a wave function inside openModal previously. This wave function makes the hand wave.

// Previous version of openModal
function openModal() {
wave()
// ...
}

When we build libraries, we need to be careful about what we put into the library. In this case, it doesn’t make sense to write wave inside modal.js because most modals don’t have a waving hand animation.

We can provide a callback for users to inject wave into the Modal library. Since the wave animation runs after the modal opens, we call this callback afterOpen.

Users can pass in the wave animation like this:

main.js
Modal({
// ...
afterOpen: wave,
})

We’ll run the wave animation like this:

export default function Modal(settings) {
// Declare variables
const modal = {
open() {
overlayElement.classList.add('is-open')
settings.afterOpen()
},
}
// Add event listeners
}

We’ll get an error if the user doesn’t pass in an afterOpen setting. There are two ways to handle this:

  1. Check with a condition
  2. Use a fallback function

Option 1 (Check with a condition) looks like this:

export default function Modal(settings) {
// Declare variables
const modal = {
open() {
overlayElement.classList.add('is-open')
if (settings.afterOpen) {
settings.afterOpen()
}
},
}
// Add event listeners
}

Option 2 is neater. We can provide an empty function as the fallback to run.

It’s often easier to do this with a default settings object. When we create the component, we need to overwrite this default setting object with the options the user passed in.

// Default settings object
const defaults = {
buttonElement: '',
modalElement: '',
afterOpen() {}, // Empty function used as a fallback
}
export default function Modal(settings) {
// Overwrite default settings with user settings
settings = Object.assign({}, defaults, settings)
// ...
}

We can now write afterOpen without checking for conditions.

export default function Modal(settings) {
// Overwrite settings
// Declare variables
const modal = {
open() {
overlayElement.classList.add('is-open')
settings.afterOpen()
},
}
// Add event listeners
}

Importing GSAP

The wave function depends on GSAP. We included GSAP with a <script> tag previously:

<script src="https://cdnjs.cloudflare.com/ajax/libs/gsap/1.20.3/TweenMax.min.js"></script>

Since we converted into ES6 modules, we can include GSAP directly inside main.js. There’s no need to use an extra script tag. This makes it clear what libraries we included in our projects.

main.js
import 'https://cdnjs.cloudflare.com/ajax/libs/gsap/1.20.3/TweenMax.min.js'

Focusing on the first element

When the modal opens, we choose to focus on the first element. Here’s the code we wrote previously:

function openModal() {
const input = modal.querySelector('input')
input.focus()
// ...
}

Since we don’t know what users will put into their modals, we cannot ensure the first element is always input. We need to check for other keyboard focusable elements as well.

The easiest way is to use a function I explained in this article.

function getKeyboardFocusableElements(element = document) {
return [
...element.querySelectorAll(
'a, button, input, textarea, select, details, [tabindex]',
),
]
.filter(el => !el.hasAttribute('disabled'))
.filter(
el => !el.hasAttribute('tabindex') || el.getAttribute('tabindex') >= 0,
)
}

We can get all keyboard focusable elements by passing .modal__content into getKeyboardFocusableElements.

export default function Modal(settings) {
// Overwrite settings
// Declare variables
const contentElement = modalElement.querySelector('.modal__content')
const modal = {
open() {
overlayElement.classList.add('is-open')
settings.afterOpen()
const focusableEls = getKeyboardFocusableElements(contentElement)
},
}
// Add event listeners
}

We then focus on the first focusable element (if there are any).

export default function Modal(settings) {
// Overwrite settings
// Declare variables
const contentElement = modalElement.querySelector('.modal__content')
const modal = {
open() {
overlayElement.classList.add('is-open')
settings.afterOpen()
const focusableEls = getKeyboardFocusableElements(contentElement)
if (focusableEls[0]) focusableEls[0].focus()
},
}
// Add event listeners
}

Trapping focus

Next, we want to trap focus inside the modal. Here’s what we wrote previously:

function openModal() {
document.addEventListener('keydown', trapFocus)
// ...
}

trapFocus looks like this right now:

function trapFocus(event) {
const focusables = modal.querySelectorAll('input, button')
const firstFocusable = focusables[0]
const lastFocusable = focusables[focusables.length - 1]
// Directs to first focusable
if (
document.activeElement === lastFocusable &&
event.key === 'Tab' &&
!event.shiftKey
) {
event.preventDefault()
firstFocusable.focus()
}
// Directs to last focusable
if (
document.activeElement === firstFocusable &&
event.key === 'Tab' &&
event.shiftKey
) {
event.preventDefault()
lastFocusable.focus()
}
}

We know we check for all possible keyboard focusable elements, not just buttons and input fields. So we need to use getKeyboardFocusableElements in trapFocus.

This time, we’re going to pass the modal into getKeyboardFocusableElements because we want to include the close button (which is contentElement’s sibling).

function trapFocus(event) {
const focusables = getKeyboardFocusableElements(modalElement)
const firstFocusable = focusables[0]
const lastFocusable = focusables[focusables.length - 1]
// ...
}

Here’s the question: How do you get modalElement into trapFocus?

There are two methods:

  1. Declare trapFocus inside Modal
  2. Use bind to add modal to trapFocus

The first method is easier. We can declare trapFocus inside Modal. If we do this, trapFocus has access to all variables declared in the lexical scope.

// Method 1
export default function Modal(settings) {
// Overwrite settings
// Declare variables
function trapFocus(event) {
// ...
}
const modal = {
open() {
// ...
document.addEventListener('keydown', trapFocus)
},
}
// Add event listeners
}

The second method is more advanced. We declare trapFocus outside Modal. Then, we create a new function inside Modal with bind.

// Method 2
export default function Modal(settings) {
// ...
// Step 2: Pass `modal` into `trapFocus` with `bind`.
const trapFocusInModal = trapFocus.bind(null, modalElement)
const modal = {
open() {
// ...
// Step 3: Use `trapFocusInModal`
document.addEventListener('keydown', trapFocusInModal)
},
}
// ...
}
// Step 1: Create a trapFocus function.
function trapFocus(element, event) {
const focusables = getKeyboardFocusableElements(element)
// ...
}

Which method is better? It depends on your circumstances.

Method 1 is simpler. We simply create a trapFocus method meant for each instance.

Method 2 is more customizable because it lets you change the element you want to trap focus in. It works better if your trapFocus is a library.

We’ll go with method 1 here since it’s easier to grasp.

Setting aria-expanded to true

Next, we want to set the button’s aria-expanded property to true when the modal is open.

Here’s the code we wrote previously.

function openModal() {
modalButton.setAttribute('aria-expanded', true)
}

In Modal, we declared the button as buttonElement. This step is as simple as copying the code (with adjustments) into open.

export default function Modal(settings) {
// Overwrite settings
// Declare variables
const modal = {
open() {
// ...
buttonElement.setAttribute('aria-expanded', true)
},
}
// Add event listeners
}
Changed button's aria-expanded attribute to true.

Preventing screen readers from reading sibling elements

When the modal is open, we want to prevent screen readers from reading other elements. We do this by setting aria-hidden on all sibling elements.

In the previous version, the only sibling element is main. So our code is easy:

function openModal() {
main.setAttribute('aria-hidden', true)
}

This time, we cannot be sure that main is the only other sibling element. We need to add aria-hidden to all possible sibling elements.

The easiest way is to find all sibling elements, loop through them, and add aria-hidden to them.

export default function Modal(settings) {
// Overwrite settings
// Declare variables
const modal = {
open() {
// ...
const overlaySiblingEls = [
...overlayElement.parentElement.children,
].filter(el => el !== overlayElement)
overlaySiblingEls.forEach(element => {
element.setAttribute('aria-hidden', true)
})
},
}
// Add event listeners
}

Root elements in the DOM should have an aria-hidden attribute after you open the modal.

Aria-hidden set to true.

That’s it! We’ll work on closing the modal next.