PolygonInput

Form input for drawing a GeoJSON.Polygon. Renders a Geoman toolbar with the polygon and cut tools.

Installation

pnpm dlx shadcn@latest add @shadmin/polygon-input

Usage

import { PolygonInput } from "@/components/leaflet";
 
<Create>
  <SimpleForm>
    <PolygonInput
      source="geom"
      label="Service area"
      defaultCenter={[48.85, 2.35]}
    />
  </SimpleForm>
</Create>;

Props

Prop	Required	Type	Default	Description
`source`	Required	`string`	-	RHF field to write the geometry to.
`allowSelfIntersection`	Optional	`boolean`	-	Reserved (validator hook). Not enforced in v1.
`minVertices`	Optional	`number`	-	Reserved (validator hook). Not enforced in v1.
`maxVertices`	Optional	`number`	-	Reserved (validator hook). Not enforced in v1.
`minArea_m2`	Optional	`number`	-	Reserved (validator hook). Not enforced in v1.
`zoom`	Optional	`number`	`13`	Initial zoom level.
`defaultCenter`	Optional	`[number, number]`	`[0, 0]`	Initial map center `[lat, lng]`.
`height`	Optional	`number \| string`	`300`	Height of the map container.
`tileUrl`	Optional	`string`	OpenStreetMap tile URL	Tile layer URL template.
`attribution`	Optional	`string`	OSM attribution	Tile attribution string.
`pathOptions`	Optional	`L.PathOptions`	-	Vector styling for the polygon.
`snappable`	Optional	`boolean`	`true`	Enable Geoman snap-to-vertex.
`snapDistance`	Optional	`number`	`20`	Snap radius in pixels.
`label`	Optional	`ReactNode`	-	Label rendered above the map.
`helperText`	Optional	`ReactNode`	-	Helper text rendered below the map.
`disabled`	Optional	`boolean`	`false`	Disable editing.
`validate`	Optional	`(v) => string \| undefined`	-	RHF-compatible validator(s).