README.md

Accessible Astro Dashboard

This Dashboard theme is build upon the (awesome) Astro Static Site Builder. To help you build your project faster, this theme includes some dedicated accessible components (such as a keyboard accessible and responsive navigation) and several components coming from the Accessible Astro Components npm package. This theme also includes example pages, admin pages, a custom 404 page and many Design System utility classes, patterns and primatives (such as grids, buttons, lists, spacings, sizes and more).

Live demo

Getting started

Run the following commands in your project folder to get started:

npm install && npm start

(Accessibility) features

• Contains a login.astro page with an example login using the localStorage and a separate LoginLayout.astro layout
• login.astro contains example login data and a warning notification for when the credentials are incorrect
• Contains a dashboard example in the index.astro page using the DefaultLayout.astro layout
• Several examples of admin pages such as media.astro, messages.astro, products.astro, settings.astro and users.astro
• Media.astro component for images, used on the media.astro page *
• Pagination.astro component for paginating results, used on the media.astro page *
• DashboardWidget.astro component serves as an example for the dashboard on index.astro
• EmpyState.astro component which can be displayed on pages that don't have any data yet
• LoginForm.astro component with a basic accessible login form and some form controls
• SkipLinks.astro component to skip to either the main menu or the main content *
• Navigation.astro component with keyboard accessible navigation (arrow keys, escape key)
  • This component is a comprehensive sidebar navigation on desktop with the option to expand or collapse
  • The users menu width preference is stored in a localStorage value so that it is preserved during page reloads
  • The navigation automatically switches to an accessible mobile navigation for viewport widths below the medium breakpoint
• ResponsiveToggle.astro component with an accessible responsive toggle button for the mobile navigation
• DarkMode.astro component toggle with accessible button which saves the users preference in the localStorage *
• 404.astro provides a custom 404 error page which you can adjust to your needs
• .sr-only utility class for screen reader only text content
• prefers-reduced-motion disables animations for users that have this preference turned on
• Outline focus indicator which works on dark and light backgrounds
• Accessible Astro Components package comes preinstalled with extra components such as Accordions, Modals and Notifications
• Nate Moore's awesome Astro Icon package is also preinstalled which can be applied to different use cases

*Provided by the Accessible Astro Components package

Login & Authentication

This starter contains a basic example of authentication and redirecting based on a users logged in status. However, this is done using SSG, which is not ideal, but serves the purpose of this demo. For better authentication and redirecting you should use Astro's (experimental) SSR.

Enabling SSR

For the purpose of the demo I have not enabled SSR, simply due to the fact how I've setup the demo websites of all accessible-astro.dev subdomains. However, I might add it in the future. It is the preferred way to handle your login and redirect cases.

LoginForm.astro

This theme contains an example login flow, using a fake email address and password and by utilizing the localStorage. All pages redirect to /login.astro if you haven't logged in. After logging in the value isLoggedIn is set to true and your authenticated to view the admin pages. When building this using SSR you should use cookies instead of the localStorage.

⚠️ Note: this is just an example, make sure you build your own secure authentication. Checkout this official Astro Blog post for more information about authentication and login.

<script>
// fetch your data from an API
// and replace that with an actual user object for example

submitButton.addEventListener('click', event => {
  event.preventDefault()

  if (emailInput.value === '[email protected]' && passwordInput.value === 'Astronaut570') {
    localStorage.setItem('isLoggedIn', 'true')
    window.location.href = '/'
  }
})
</script>

DefaultLayout.astro

---
import { getUser } from '../api/index.js'

const user = await getUser(Astro.request)

if (!user) {
  return Astro.redirect('/login')
}
---

Utilities

This theme contains some extra Design System like utility classes to aid in the global layout of your project. All of this can be found in the public/scss/base directory, and compiles in the globals.scss file. Using these primitives is totally optional, use or remove at your own preference :) What it contains:

• Reset file to reset browser defaults and ensure everything looks good
• Some basic font settings, such as responsive heading sizes
• Color shades for your color pallet, rendered to the :root of your website as custom properties
• Simple auto-grid setting using display: grid and a data-attribute
• A bit more advanced grid settings using display grid to easily setup a 12-column layout
• Utilities set in _utility.scss for things such as spacing, sizes, colors, and box-shadows

12 Column Grid

12 Column Grid enables you to build custom column based layouts. Using display: grid; you can define the amount of columns that elements should take up in your .grid, and for which breakpoint they should do so. You can also use offset on a grid to create an extra column of offset. The grid offers different utilities for the individual grid items such equal-height, x-start, x-center, x-end, y-start, y-center and y-end. Grid comes with default gutters, to disable them you can use the utility class no-gutters.

<div class="container">
  <div class="grid">
    <div class="small-12 medium-3">
      <h3>Sidebar</h3>
      <!-- ... -->
    </div>
    <div class="small-12 medium-8 offset-medium-4">
      <h3>Main</h3>
      <!-- ... -->
    </div>
  </div>
</div>

Alignment

Alignment classes can be used to align elements in your HTML. There's align-center, align-horizontal and align-vertical.

<div class="align-center w-screen h-screen">
  <h1>Center me on the screen!</h1>
</div>

Animations

There are a couple of basic animations which you can throw on your HTML elements like blink, fade-in, pop-up and spin. You can also use some animation delays to create different effects.

<div data-animation="fade-in">
  <p>I've got a fancy fade-in animation that starts right away.</p>
</div>
<div data-animation="fade-in" data-animation-delay="0.25s">
  <p>I've got a fancy fade-in animation after 0.25s.</p>
</div>
<div data-animation="fade-in" data-animation-delay="0.5s">>
  <p>I've got a fancy fade-in animation after 0.5s.</p>
</div>

Auto Grid

Simply apply the data-auto-grid attribute on your parent div with a number from 2-6 (if you need more columns just tweak the for loop in _auto-grid.scss). The grid automatically creates new rows (this is how display: grid works by default).

<div class="container" data-auto-grid="3">
  <p>First column</p>
  <p>Second column</p>
  <p>Third column</p>
</div>

You can also center the contents of the cell using the data-grid-center attribute. Use it together with data-auto-grid.

<div class="container" data-auto-grid="3" data-grid-center>
  <!-- ... -->
</div>

Borders

With two border radius utility classes (radius-small and radius-large) you can change the border radius of your HTML elements on the fly.

<div class="bg-neutral-900 space-32 radius-large">
  <p>Lorem ipsum dolor sit amet consectetur adipisicing elit.</p>
</div>

Buttons

A Button primitive to easily apply button styles to your <button> and <a> tags. Simply apply the class button to your element. There are different variations in colors (color-secondary, color-info, color-success, color-warning, color-error) which is primary by default, sizing (size-tiny, size-large, size-huge) which is medium by default and behavior (behavior-full) which stretches the button to 100% width.

<a href="/" class="button color-success size-huge behavior-full">
  Click me to go to space!
</a>

Colors

You can setup your own color schemes in the _colors.scss file. You'll find a SCSS map, which gets printed inside _root.scss as custom properties. There are also several color utilities such as text-primary-# and bg-neutral-# based on all colors you've defined. text-primary-# should be used on a parent element to give the child's the respective color.

$colors: (
  primary: (
    100: hsl(262, 90%, 95%),
    200: hsl(262, 100%, 88%),
    300: hsl(262, 100%, 78%),
    400: hsl(268, 82%, 60%),
    500: hsl(273, 79%, 48%),
  ),
  // ...
);

<div class="text-neutral-100 bg-neutral-900 space-32">
  <p>Dark background with white text on it!</p>
</div>

Elevations

Use elevations on your HTML elements to add a box shadow of different intensities. Use either elevation-100, elevation-200, elevation-300, elevation-400 or elevation-500.

<div class="space-32 radius-large elevation-400">
  <p>Lorem ipsum dolor sit amet consectetur adipisicing elit.</p>
</div>

Height / Width

You can set the height and width of your elements to either 100 view port units or percentages using h-screen, h-full, w-screen and w-full respectfully.

<div class="h-screen w-screen align-center">
  <p>I'm centered in the middle of the screen!</p>
</div>

Margins, Paddings and Spaces

To prevent spacing each element in your website individually and to prevent inconsistencies, you can use the .margin-# and .padding-# utility classes. A good practice is to set in on your <section> elements, for starters. To space out content you can use a special .space-content class on your parent div (for example an element of your .grid). By default, margin/padding top and bottom are set with these utilities. You can also set it explicitly using either .top of .bottom class tokens. Find or tweak all spacing options in _space.scss. space-# tokens however add padding all around an element, which is great of you need to make card like blocks on the fly by combining space with the other utilities.

<section class="padding-32">
  <div class="container">
    <h2 class="margin-16 bottom">Grid example</h2>
  </div>
</section>

<div class="box space-32 bg-primary-200 radius-small elevation-100">
  <div class="space-content">
    <h3>I look like a card!</h3>
    <p>And space-content adds space between us for readability.</p>
  </div>
</div>

Sizes

If you need an exception on your font-size for a specific reason you can use size utility classes to accomplish that. Using it is easy. Find or tweak all spacing options in _size.scss.

<div class="container">
  <p class="size-20">I'm a bigger font size!</p>
</div>

Other Accessible Astro projects

• Accessible Astro Starter
• Accessible Astro Components
• Accessible Astro Documentation

Helping out

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

1. Filing an issue
2. Submitting a pull request
3. Starting a discussion
4. Buying me a coffee!

Thank you!

A big thank you to the creators of the awesome Astro static site generator and to all using this starter to make the web a bit more accessible for all people around the world :)