@sakuzu/maplibre-gl-draw-ui 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,96 @@
+/**
+ * The standard user interface of `@sakuzu/maplibre-gl-draw`: a toolbar of the drawing tools at
+ * the bottom of the map, with keyboard shortcuts.
+ *
+ * The interface keeps nothing of the drawing. It reads the draw instance and follows its events
+ * (the current tool is `draw.getMode()`, the selection `draw.selection.get()`), and every button
+ * calls the public API of the draw instance, so an application can mix it with controls of its
+ * own and they never disagree.
+ *
+ * ```ts
+ * import { createDraw } from '@sakuzu/maplibre-gl-draw';
+ * import { createDrawUI } from '@sakuzu/maplibre-gl-draw-ui';
+ * import '@sakuzu/maplibre-gl-draw-ui/style.css';
+ *
+ * const draw = createDraw(map);
+ * const ui = createDrawUI(draw, { locale: 'ja' });
+ * ```
+ *
+ * @module maplibre-gl-draw-ui
+ */
+import type { Draw } from '@sakuzu/maplibre-gl-draw';
+import type { InspectorHandle, InspectorOptions } from './inspector/types.js';
+import type { AloneOptions, DrawUI, DrawUIOptions, LayerPanelHandle, LayerPanelOptions, LegendHandle, ToolbarHandle, ToolbarOptions } from './types.js';
+export type { InspectorField, InspectorFieldKind, InspectorHandle, InspectorOptions, InspectorSectionSpec, InspectorSectionsHandle, InspectorTab, Units, } from './inspector/types.js';
+export type { Locale, Messages } from './messages.js';
+export type { Theme } from './theme.js';
+export type { AloneOptions, DrawUI, DrawUIOptions, LayerPanelHandle, LayerPanelOptions, LegendHandle, MapControlsOptions, ToolbarHandle, ToolbarOptions, ToolEntry, ToolId, ToolSpec, ToolsHandle, } from './types.js';
+/**
+ * Lays the interface over the map of a draw instance: kata's Shell with the toolbar at the
+ * bottom and the keyboard shortcuts.
+ *
+ * It draws the toolbar, the shortcuts, the layer panel and the legend on the left, and the
+ * inspector on the right while something is selected. The map's padding follows the interface:
+ * the width of a panel that stands beside the map (on a wide container) and the toolbar's height
+ * at the bottom, so that `fitBounds` and `easeTo` keep clear of them; `destroy()` gives the map
+ * its padding back. A button at the top right switches between the light and the dark look, and
+ * maplibre-gl's own controls go to the bottom corners of the map (the globe, the compass and the
+ * zoom at the right, the scale at the left); `destroy()` removes them.
+ *
+ * @param draw - The draw instance
+ * @param options - What to show, the words and the keys
+ * @returns The interface, to change and to remove
+ * @throws Error when a tool of `options.toolbar.tools` is not valid, a tab of
+ *   `options.inspector.tabs` is not `style` or `attributes`, or the theme is not `light`, `dark`
+ *   or `auto`
+ */
+export declare function createDrawUI(draw: Draw, options?: DrawUIOptions): DrawUI;
+/**
+ * Puts the toolbar alone in an element: the tools, the delete button and the snapping switch,
+ * without the keyboard shortcuts. The bar floats at the bottom centre of `target`, which must be
+ * positioned (the map's container, or a positioned box over the map).
+ *
+ * @param draw - The draw instance
+ * @param options - The element to put it in, what it shows, the words (`en` by default) and the
+ *   theme (`auto` by default)
+ * @returns The toolbar, to remove
+ * @throws Error when a tool of `options.tools` is not valid, or the theme is not `light`, `dark`
+ *   or `auto`
+ */
+export declare function createToolbar(draw: Draw, options: ToolbarOptions & AloneOptions): ToolbarHandle;
+/**
+ * Puts the layer panel alone in an element: the tree of the layers, their groups and their
+ * features, from the front, with the eye, the lock, renaming, dragging and the add menu. It fills
+ * `target`, which gives it its size and its scrolling.
+ *
+ * @param draw - The draw instance
+ * @param options - The element to put it in, what it shows, the words (`en` by default) and the
+ *   theme (`auto` by default)
+ * @returns The layer panel, to remove
+ * @throws Error when the theme is not `light`, `dark` or `auto`
+ */
+export declare function createLayerPanel(draw: Draw, options: LayerPanelOptions & AloneOptions): LayerPanelHandle;
+/**
+ * Puts the legend alone in an element: the rows of the style rule of each layer that has one,
+ * from the front. It only reads; the rules change with `draw.layers.update`.
+ *
+ * @param draw - The draw instance
+ * @param options - The element to put it in, the words (`en` by default) and the theme (`auto` by
+ *   default)
+ * @returns The legend, to remove
+ * @throws Error when the theme is not `light`, `dark` or `auto`
+ */
+export declare function createLegend(draw: Draw, options: AloneOptions): LegendHandle;
+/**
+ * Puts the inspector alone in an element: the panel of what is selected (a feature, several
+ * features, a layer or a group), with an empty state while nothing is. The panel fills the height
+ * of `target`.
+ *
+ * @param draw - The draw instance
+ * @param options - The element to put it in, the tabs, the measurements, the operations, the
+ *   units, the words (`en` by default) and the theme (`auto` by default)
+ * @returns The inspector, to add sections to and to remove
+ * @throws Error when a tab of `options.tabs` is not `style` or `attributes`, or the theme is not
+ *   `light`, `dark` or `auto`
+ */
+export declare function createInspector(draw: Draw, options: InspectorOptions & AloneOptions): InspectorHandle;