svelte-tabindex v1.0.0

svelte-tabindex

A Svelte component for managing tabindex.

Installation

npm install svelte-tabindex

How does it works ?

<NoTab>...</NoTab> creates a reactive svelte context (using writable) so that its children can update their tabindex.

Every fousable element of your app (links, buttons, inputs ...) must get the context to implement this behaviour.

The context value is an object ({ tabindex : Number }) you can spread as node attribute to do so.

Usage

Link.svelte (a simple link wrapper that gets the svelte-tabindex context)

<script>
  import { getContext } from 'svelte';
  import { contextKey } from 'svelte-tabindex';

  export let href = '';
  let tabindexAttr = getContext(contextKey);
</script>

<a {href} {...$tabindexAttr}><slot /></a>

App.svelte

<script>
    import Link from './Link.svelte'
    import { NoTab } from 'svelte-tabindex'
</script>

<Link href='/'>focusable link</Link>
<NoTab>
    <Link href='/'>non focusable link</Link>
    <Link href='/'>another non focusable link</Link>
</NoTab>
<Link href='/'>another focusable link</Link>

Advanced usage

(e.g. src/routes/index.svelte)

active attribute

The <NoTab> component has an active (Boolean) attribute witch can be used to dynamically toggle its behaviour.

Nested NoTab contexts

Your app may need to have nested untabble regions (e.g. collapsible menu). In that case any active <NoTab/> ancestor will override the active state of any NoTab descendants. You can bypass this feature by using the reset attribute

reset attribute

The <NoTab> component has a reset attribute that allows you to ignore the state of any active ancestors. It can be used for modals, as the whole app would be wrapped in an active <NoTab> component, a modal component wrapped in its own <NoTab reset> would not inherit its active state from its ancestors.