Vinicunca

Config Provider

Wraps your app to provide global configurations.
  • Enables all primitives to inherit global reading direction.
  • Enables changing the behavior of scroll body when setting body lock.
  • Much more controls to prevent layout shifts.

Anatomy

Import the component.

<script setup lang="ts">
import { ConfigProvider } from 'akar';
</script>

<template>
  <ConfigProvider>
    <slot />
  </ConfigProvider>
</template>

API Reference

Config Provider

When creating localized apps that require right-to-left (RTL) reading direction, you need to wrap your application with the ConfigProvider component to ensure all of the primitives adjust their behavior based on the dir prop.

You can also change the global behavior of bodylock for components such as Alert, DropdownMenu and etc to fit your layout to prevent any content shifts.

PropDefaultType
dir
"ltr"
"ltr" | "rtl"

The global reading direction of your application. This will be inherited by all primitives.

locale
"en"
string

The global locale of your application. This will be inherited by all primitives.

nonce
string

The global nonce value of your application. This will be inherited by the related primitives.

scrollBody
true
boolean | ScrollBodyOption

The global scroll body behavior of your application. This will be inherited by the related primitives.

teleportTo
string | HTMLElement

The global default teleport target for all portalled primitives (e.g. Dialog, Popover, Tooltip). Individual *Portal components can still override this via their own to prop. Useful when rendering inside a custom element / shadow DOM.

useId
(() => string)

The global useId injection as a workaround for preventing hydration issue.

ConfigProvider.vue source

Example

Use the config provider.

Set global direction to rtl, and scroll body behavior to false (will not set any padding/margin).

<script setup lang="ts">
import { ConfigProvider } from 'akar';
</script>

<template>
  <ConfigProvider
    dir="rtl"
    :scroll-body="false"
  >
    <slot />
  </ConfigProvider>
</template>

Hydration issue

ConfigProvider can accept a custom useId function for frameworks that need to provide their own SSR-stable ID source. Akar uses this function before Vue's native useId, so every primitive that generates accessibility IDs follows the same app-provided source.

This is useful in Nuxt projects where prerendered HTML and client hydration can use different Vue app ID prefixes. Pass Nuxt's useId through ConfigProvider so Reka-generated IDs stay stable across server and client rendering.

Inspired by Headless UI

<!-- in Nuxt's app.vue -->
<script setup lang="ts">
import { ConfigProvider } from 'akar';

const useIdFunction = () => useId();
</script>

<template>
  <ConfigProvider :use-id="useIdFunction">
    …
  </ConfigProvider>
</template>

Focus Scope

Manages focus within a component boundary with support for trapping and looping focus navigation.