Map Controls
Declarative zoom, compass, geolocate, fullscreen and scale controls for a map, placed at a corner.
Preview
Controls
Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.
Installation
php artisan ui:add map-controls
Registry contract
Install confidence
php artisan ui:add map-controls
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-controls.blade.php |
Registry dependencies
Package dependencies
composer: jml/brok:^1.0
Guidance
Geospatial viewSupport 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-controls 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
API
manifest knowledge + registry-derived coverageProps
| Prop | Type / values | Default | Description |
|---|---|---|---|
| position | string | top-right | Declared by @props in the registry Blade source. |
| showZoom | bool | true | Declared by @props in the registry Blade source. |
| showCompass | bool | true | Declared by @props in the registry Blade source. |
| showLocate | bool | false | Declared by @props in the registry Blade source. |
| showFullscreen | bool | false | Declared by @props in the registry Blade source. |
| showScale | 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-controls
Capabilities
Behavior
- Uses server-rendered Blade and semantic HTML.
- Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.
Usage
<x-ui.map :center="[2.3522, 48.8566]" :zoom="10" height="420px" label="{{ __('Map controls') }}">
<x-ui.map-controls position="top-right" show-zoom show-compass show-locate show-fullscreen />
</x-ui.map>
Accessibility & localization
data-slot
Keyboard focus-visible
Localized labels
- Accessibility target: wcag-2.2-aa-target.
- Uses semantic HTML and a stable
data-slotattribute for styling/scripting hooks. - Focus-visible rings use the
ringtoken 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.