Preview

Controls

Theme

Surface

Direction

Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal

php artisan ui:add map-route

Registry contract

Install confidence

php artisan ui:add map-route writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version: 1.0.0
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/map-route.blade.php

Registry dependencies

map

Package dependencies

composer: jml/brok:^1.0

Guidance

Geospatial view

Support a decision that depends on geography or distance.

Use when

Use when geography, route, clustering, or distance meaningfully affects decisions. Do not use a map as decoration when location is not central to the task.

Avoid when

Avoid using map-route as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.

Task length: medium
Interaction cost: high
Interruptiveness: none
Input precision: none
Mobile / touch risk: high
Accessibility risk: high
Needs background context: No
Comparison needed: Yes

Preferred alternatives

Location list or distance table

Anti-patterns

Using a map as decorative scenery

Related: map

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
coordinates	array	[]	Declared by @props in the registry Blade source.
color	string	primary	Declared by @props in the registry Blade source.
width	int	4	Declared by @props in the registry Blade source.
opacity	float	0.85	Declared by @props in the registry Blade source.
dashed	bool	false	Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

map-route

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

Uses server-rendered Blade and semantic HTML.
Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.map-route.default.blade.php Blade

<x-ui.map :center="[-73.978, 40.75]" :zoom="12" height="420px" label="{{ __('Map route') }}">
    <x-ui.map-controls position="top-right" show-zoom />
    <x-ui.map-route
        :coordinates="[[-73.991, 40.735], [-73.987, 40.744], [-73.982, 40.749], [-73.974, 40.755], [-73.968, 40.764]]"
        color="primary"
        :width="5"
    />
    <x-ui.map-marker :lng="-73.991" :lat="40.735" color="success" :label="__('Start')" />
    <x-ui.map-marker :lng="-73.968" :lat="40.764" color="destructive" :label="__('Destination')" />
</x-ui.map>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels

Accessibility target: wcag-2.2-aa-target.
Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
Focus-visible rings use the ring token so keyboard focus is always visible.
Disabled and invalid states are conveyed to assistive tech, not by color alone.
Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.0.0. See the site changelog for the full release history.

Map Route