` would be too limiting
- To maintain readable text within the Card on larger screen sizes, `max-width` is set to `70ch`

#### Example

```astro
---
import { Card } from 'accessible-astro-components'
---

• 
  
  Lorem ipsum dolor sit amet.
  
  


• 
  
  

```

```scss

ul {
display: grid;
grid-template-columns: 1fr;
grid-gap: 4rem;

@media (min-width: 550px) {
grid-template-columns: repeat(2, 1fr);
grid-gap: 2rem;
}

@media (min-width: 950px) {
grid-template-columns: repeat(3, 1fr);
}
}

```

#### Overwriting styles

You can apply your own styles by either setting the individual properties using `:global(body .card)` for example, or set up a global style tag and define your styles in there:

```scss

body .card {
color: purple;
background-color: blue;

a {
color: gold;
}
}

// set your own image height
.card__image {
height: 10rem;
}

```

### DarkMode

DarkMode is a toggle button component to add and remove a class of `.darkmode` to the `` based on the user's preference for either a light or dark color scheme. The user's preference is saved to the `localStorage` to preserve their choice for future visits.

**Some (accessibility) features of the DarkMode**:

- Utilizes `aria-pressed` to indicate to screen reader users whether the dark scheme is toggled or not
- Gives feedback to screen reader users which state is toggled using `aria-label`s
- Uses `aria-hidden` to hide the icons for dark and light mode and uses the `aria-labels`s instead
- Sets the `color-scheme` to `light` or `dark` based on the user's preference so you can use the `light-dark()` function in your CSS

#### Props

- `initialMode` (optional): Sets the initial color scheme. Accepts `'light'`, `'dark'`, or `'auto'` (default: `'auto'`)
- `'light'`: Forces light mode on first visit
- `'dark'`: Forces dark mode on first visit
- `'auto'`: Uses system preferences on first visit

#### Example

```astro
---
import { DarkMode } from 'accessible-astro-components'
---

```

```scss

body.darkmode {
// define your dark color scheme
}

```

Note: After the first visit, the user's chosen preference will be saved to localStorage and will take precedence over the `initialMode` setting.

### Media

- [When is an image descriptive](https://www.w3.org/WAI/tutorials/images/decorative/)

Media is a very simple component used for `` tags. It has a default empty `alt` tag which is required for non-decorative images. Should the image be descriptive, for example when there's no (complementary) text, then you should always write a good descriptive `alt` tag. The Media component also utilizes the `loading="lazy"` tag to optimize performance from the browsers side.

**Some (accessibility) features of the Media**:

- Sets a default empty `alt` tag which is always required for non descriptive images.

#### Example

```astro
---
import { Media } from 'accessible-astro-components'
---

```

### Modal

- [When (not) to use](https://www.nngroup.com/articles/modal-nonmodal-dialog/)

Modals are windows that appear on top of the parent screen, usually disabling the use of the parent screen and demanding immediate action from the user. This component uses the native HTML `` element for built-in accessibility and functionality, enhanced with smooth transitions.

**Some (accessibility) features of the Modal**:

- Uses native HTML `` element for built-in accessibility
- Closing Modal with the Escape key
- Trapping focus inside Modal using Tab and Shift + Tab
- Linking the trigger element and the Modal using `id` and `aria-labeledby`
- Setting focus back on the element that triggered the Modal after closing
- Smooth transitions using `@starting-style` and `allow-discrete`
- Respects user's reduced-motion preferences

#### Example

```astro
---
import { Modal } from 'accessible-astro-components'
---
Modal 1
Modal 2

Why hello, I be the first Modal.

Ah yes, and I be the second Modal.

Confirm action

```

#### Overwriting styles

You can apply your own styles by either setting the individual properties using `:global(body .modal)` for example, or set up a global style tag and define your styles in there:

```scss

body {
.modal {
color: purple;
background-color: gold;
}

.modal__inner {
border-color: orange;
}

.modal__content {
gap: 1.5rem;
padding: 1rem;
}

.modal__close button {
color: white;
background-color: blue;

&:hover,
&:focus {
background-color: green;
}
}
}

```

### Notification

Notifications are often used to keep the user updated about changing state on a website or application. They can also be used as a general way to display some highlighted information in an article for example. There are two rules of thumb when it comes to Notifications and those are to always add contextual information about the Notification (such as starting with "Tip:", "Info:", "Error:") and when adding a Notification to the DOM in response to a user action, you should always use `role="status"` and `aria-live="polite"` to inform screen reader users. To add some extra visuals you can combine the Notification component with [Astro Icon](https://github.com/natemoo-re/astro-icon).

**Some (accessibility) features of the Notification**:

- Use color to identify the type of Notification (info, success, warning, error)
- Provide contextual feedback besides just color by mentioning what type of Notification is displayed
- Help identify content to screen reader users with `role="status"` and `aria-live="polite"`

#### Example

```astro
---
import { Notification } from 'accessible-astro-components'
---

Info: This is a notification of type info.

Info: This is a notification of type info.

Info: This is a notification of type info.

```

#### Overwriting styles

You can apply your own styles by either setting the individual properties using `:global(body .notification)` for example, or set up a global style tag and define your styles in there:

```scss

body {
.notification {
color: var(--neutral-900, #202427);
background-color: var(--neutral-200, #f6f8f9);
border: 2px solid var(--neutral-600, #858d93);

&.type-info {
color: var(--info-900, #035486);
background-color: var(--info-100, #e0f7ff);
border-color: var(--info-600, #1a91d1);
}

&.type-success {
color: var(--success-900, #014b3e);
background-color: var(--success-100, #eefcf6);
border-color: var(--success-500, #28a980);
}

&.type-warning {
color: var(--warning-900, #8e2a0b);
background-color: var(--warning-100, #fffbeb);
border-color: var(--warning-600, #dc901e);
}

&.type-error {
color: var(--error-900, #5e0317);
background-color: var(--error-100, #ffe0e0);
border-color: var(--error-500, #df2a39);
}
}
}

```

### Pagination

A fairly simple yet effective Pagination component which has a first, previous, next, and last page button. It also tells the user how many pages there are and what page they are currently on. The Pagination component is also fully accessible and keyboard navigable.

**Some (accessibility) features of the Pagination**:

- Uses `aria-label`s to tell the user whether they will go to the previous or next page and which page number
- Uses `aria-hidden` to hide the icons for the previous and next pages
- Disables the first and previous page buttons when on the first page
- Disables the last and next page buttons when on the last page

#### Example

```astro
---
import { Pagination } from 'accessible-astro-components'
---

```

#### Example using Astro's [Dynamic Pages](https://docs.astro.build/core-concepts/astro-pages#dynamic-pages)

```astro
---
import { Pagination } from 'accessible-astro-components'

export async function getStaticPaths({ paginate }) {
const response = await fetch('https://jsonplaceholder.typicode.com/posts')
const data = await response.json()

return paginate(data, { pageSize: 6 })
}

const { page } = Astro.props
---

```

#### Overwriting styles

You can apply your own styles by either setting the individual properties using `:global(body .pagination)` for example, or set up a global style tag and define your styles in there:

```scss

body .pagination a {
svg path {
stroke: gold;
}

&:hover,
&:focus-visible {
background-color: purple;

svg path {
stroke: white;
}
}

.disabled {
border-color: red;
opacity: 0.1;
}
}

```

### SkipLinks

SkipLinks provide a way for users using assistive technologies to skip repeated content on pages to go directly to the main content of a website or application. To use this component properly, make sure you give the main content of your project an `id` of `#main-content` so that the SkipLink can target it. As a fallback the SkipLink will try to target the `h1` of the page. If neither are found a warning will be logged to the console.

**Some (accessibility) features of the SkipLinks**:

- Lets assistive technologies skip to the main navigation and main content of a website

#### Example

```astro
---
import { SkipLinks } from 'accessible-astro-components'
---

```

#### Overwriting styles

You can apply your own styles by either setting the individual properties using `:global(body .skiplinks)` for example, or set up a global style tag and define your styles in there:

```scss

body .skiplinks a {
color: white;
background-color: purple;

&:hover
&:focus {
background-color: indigo;
}
}

```

### Tabs

A fully accessible tabs component that follows WAI-ARIA guidelines. Tabs are a great way to organize content into different sections, allowing users to switch between them easily.

**Some (accessibility) features of the Tabs**:

- Keyboard accessible using ArrowLeft and ArrowRight
- Tabbing through the tabs using Tab and Shift + Tab
- Linking the trigger element and the tabs using `id`, `aria-controls` and `aria-labelledby`
- Using proper roles to inform screen reader users about the tabs and panels
- Responsive design with mobile-first approach
- Smooth transitions (respecting reduced-motion preferences)

#### Example

```astro
---
import { Tabs, TabsList, TabsPanel, TabsTab } from 'accessible-astro-components'
---

Tab 1
Tab 2
Tab 3

Panel 1

Content for first panel

Panel 2

Content for second panel

Panel 3

Content for third panel

```

#### Props

**Tabs**
- `class` - Optional string for additional CSS classes

**TabsList**
- `class` - Optional string for additional CSS classes

**TabsTab**
- `id` - Required string for unique tab identification
- `controls` - Required string matching the panel ID this tab controls
- `selected` - Optional boolean to set initial selected state
- `class` - Optional string for additional CSS classes

**TabsPanel**
- `id` - Required string for unique panel identification
- `labelledby` - Required string matching the tab ID that labels this panel
- `selected` - Optional boolean to set initial selected state
- `class` - Optional string for additional CSS classes

#### Overwriting styles

You can apply your own styles by either setting the individual properties using `:global(body .tabs)` for example, or set up a global style tag and define your styles in there:

```scss

body .tabs-list {
background-color: purple;
}

```

## 📦 Other Accessible Astro projects

- [Accessible Astro Starter](https://github.com/markteekman/accessible-astro-starter/)
- [Accessible Astro Dashboard](https://github.com/markteekman/accessible-astro-dashboard/)

## ❤️ Helping out

If you find that something isn't working right then I'm always happy to hear it to improve these components! You can contribute in many ways and forms. Let me know by either:

1. [Filing an issue](https://github.com/markteekman/accessible-astro-components/issues)
2. [Submitting a pull request](https://github.com/markteekman/accessible-astro-components/pulls)
3. [Starting a discussion](https://github.com/markteekman/accessible-astro-components/discussions)
4. [Sponsoring this project](https://www.buymeacoffee.com/markteekman)

## ☕ Thank you!

I'd like to extend my gratitude to the creators of Astro and all those who have utilized these components and shared valuable insights to enhance web accessibility worldwide. Additionally, I'd like to acknowledge the contributions of notable figures in the web development community, including Zell Liew from Learn JavaScript Today and Heydon Pickering, the author of Inclusive Components, among others. Special thanks go out to all the contributors to this repository, with particular recognition for [David Abell](https://github.com/david-abell), whose substantial contributions, such as the addition of TypeScript support, have greatly benefited the project. Your collective efforts are highly appreciated!

[](https://www.buymeacoffee.com/markteekman)