@open-pioneer/legend 1.3.0-dev.20260512095810 → 1.3.0

package/CHANGELOG.md

@@ -1,12 +1,16 @@
 # @open-pioneer/legend
 
-## 1.3.0-dev.20260512095810
+## 1.3.0
 
 ### Minor Changes
 
 - 9b5d5f3: Support for new common container props (role, aria-\*, data-\* and css)
-- d54ccfd: Update to Chakra UI 3.34.0
-- 206b397: Update to trails core packages 4.5.0
+- d54ccfd: Update to Chakra UI 3.35.0
+- 206b397: Update to trails core packages 4.6.0
+
+### Patch Changes
+
+- 0704cd6: Use `classnames` from `@open-pioneer/react-utils` instead of `classnames` package.
 
 ## 1.2.0
 

package/Legend.js

@@ -1,9 +1,8 @@
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import { Box, List, Text, Icon, Image } from '@chakra-ui/react';
 import { useMapModelValue, isLayer } from '@open-pioneer/map';
-import { useCommonComponentProps } from '@open-pioneer/react-utils';
+import { useCommonComponentProps, classNames } from '@open-pioneer/react-utils';
 import { useReactiveSnapshot } from '@open-pioneer/reactivity';
-import classNames from 'classnames';
 import { useIntl } from './_virtual/hooks.js';
 import { useMemo, useState, useEffect } from 'react';
 import { LuTriangleAlert } from 'react-icons/lu';

package/Legend.js.map

@@ -1 +1 @@
-{"version":3,"file":"Legend.js","sources":["Legend.tsx"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Box, Icon, Image, List, Text } from \"@chakra-ui/react\";\nimport {\n    AnyLayer,\n    Layer,\n    MapModel,\n    MapModelProps,\n    isLayer,\n    useMapModelValue\n} from \"@open-pioneer/map\";\nimport { CommonComponentProps, useCommonComponentProps } from \"@open-pioneer/react-utils\";\nimport { useReactiveSnapshot } from \"@open-pioneer/reactivity\";\nimport classNames from \"classnames\";\nimport { useIntl } from \"open-pioneer:react-hooks\";\nimport { ComponentType, FC, ReactNode, useEffect, useMemo, useState } from \"react\";\nimport { LuTriangleAlert } from \"react-icons/lu\";\n\n/**\n * Properties of a legend item React component.\n */\nexport interface LegendItemComponentProps {\n    /**\n     * Related layer of the legend.\n     */\n    layer: AnyLayer;\n}\n\n/**\n * Attributes of the legend attribute that can be specified on a layer.\n *\n * To show a legend for the layer, provide an imageUrl to an image to show\n * or provide a React component that will be rendered as a legend.\n *\n * LegendItemAttributes should be registered with a layer as the `\"legend\"` attribute.\n */\nexport interface LegendItemAttributes {\n    /**\n     * (Optional) URL to an image that will be shown as a legend for the layer.\n     */\n    imageUrl?: string;\n\n    /**\n     * (Optional) React component that will be shown as customized legend for the layer.\n     */\n    Component?: ComponentType<LegendItemComponentProps>;\n\n    /**\n     * (Optional) Additional property to control the display of the layer in the legend.\n     */\n    listMode?: ListMode;\n}\n\n/**\n * These are special properties for the Legend.\n */\nexport interface LegendProps extends CommonComponentProps, MapModelProps {\n    /**\n     * Specifies whether legend for active base layer is shown in the legend UI.\n     * Defaults to `false`.\n     */\n    showBaseLayers?: boolean;\n}\n\n/**\n * ListMode determines if a layer item is displayed in the Legend for the layer.\n * The option `\"hide-children\"` provides a shortcut to hide all child layers (e.g. sublayers of group) of the layer in the Legend.\n * It has the same effect as manually setting the `listMode` to `\"hide\"` on all child layers.\n *\n * ListMode has precedence over the layer's `internal` attribute but specifically configures the layer's display in the legend.\n *\n * By default, the list mode becomes `\"hide-children\"` if a layer has an associated legend.\n */\nexport type ListMode = \"show\" | \"hide\" | \"hide-children\";\n\n/**\n * The `Legend` component can be used to display the legend of layers that are visible in the map.\n */\nexport const Legend: FC<LegendProps> = (props) => {\n    const { showBaseLayers = false } = props;\n    const { containerProps } = useCommonComponentProps(\"legend\", props);\n    const map = useMapModelValue(props);\n\n    return (\n        <Box {...containerProps}>\n            <LegendList map={map} showBaseLayers={showBaseLayers} />\n        </Box>\n    );\n};\n\nfunction LegendList(props: { map: MapModel; showBaseLayers: boolean }): ReactNode {\n    const { map, showBaseLayers } = props;\n\n    const layers = useLayers(map);\n    const legendListItems: ReactNode[] = layers.map((layer) => {\n        return (\n            <LegendItem key={layer.id} layer={layer} showBaseLayers={showBaseLayers}></LegendItem>\n        );\n    });\n\n    return (\n        <List.Root\n            // Note: not using UnorderedList because it adds default margins\n            as=\"ul\"\n            className=\"legend-layer-list\"\n            listStyleType=\"none\"\n            gap={2}\n        >\n            {legendListItems}\n        </List.Root>\n    );\n}\n\nfunction LegendItem(props: { layer: AnyLayer; showBaseLayers: boolean }): ReactNode {\n    const { layer, showBaseLayers } = props;\n    const { isVisible, isInternal } = useReactiveSnapshot(() => {\n        return {\n            isVisible: layer.visible,\n            isInternal: layer.internal\n        };\n    }, [layer]);\n    const childLayers = useChildLayers(layer);\n    const listModeProp = useListMode(layer);\n    const legendContent = useLegendContent(layer);\n    const listMode = getListMode(listModeProp, isInternal, !!legendContent);\n\n    if (!isVisible || listMode === \"hide\" || (!showBaseLayers && isBaseLayer(layer))) {\n        return;\n    }\n\n    // legend items for all child layers (sublayers or layers in a group)\n    let childItems: ReactNode[] = [];\n    if (listMode === \"show\") {\n        childItems = childLayers.map((child) => (\n            <LegendItem key={child.id} layer={child} showBaseLayers={showBaseLayers} />\n        ));\n    }\n    // listMode: hide/hide-children -> childItems stays empty\n\n    return (\n        <>\n            <LegendContent layer={layer} content={legendContent} />\n            {childItems}\n        </>\n    );\n}\n\nfunction LegendContent(props: { layer: AnyLayer; content: ReactNode }) {\n    const intl = useIntl();\n\n    const { layer, content } = props;\n    const baseLayer = isBaseLayer(layer);\n    return content ? (\n        <Box as=\"li\" className={classNames(\"legend-item\", `layer-${slug(layer.id)}`)}>\n            {baseLayer ? (\n                /* Render additional text, if layer is a configured basemap */\n                <Text as=\"b\">{intl.formatMessage({ id: \"basemapLabel\" })}</Text>\n            ) : null}\n            {content}\n        </Box>\n    ) : undefined;\n}\n\nfunction LegendImage(props: { imageUrl: string; layer: AnyLayer }) {\n    const intl = useIntl();\n\n    const { layer, imageUrl } = props;\n\n    const [isError, setIsError] = useState(false);\n    useEffect(() => {\n        setIsError(false);\n    }, [imageUrl]);\n\n    const content = useMemo(() => {\n        if (isError) {\n            return (\n                <Box>\n                    <Text>\n                        <Icon me={2}>\n                            <LuTriangleAlert />\n                        </Icon>\n                        {intl.formatMessage({ id: \"fallbackLabel\" })}\n                    </Text>\n                </Box>\n            );\n        }\n\n        return (\n            <Image\n                maxW=\"none\"\n                maxH=\"none\"\n                src={imageUrl}\n                alt={intl.formatMessage({ id: \"altLabel\" }, { layerName: layer.title })}\n                className={\"legend-item__image\"}\n                onError={() => setIsError(true)}\n            />\n        );\n    }, [intl, layer.title, imageUrl, isError]);\n\n    return (\n        <Box>\n            <Text>{layer.title}</Text>\n            {content}\n        </Box>\n    );\n}\n\n/**\n * Resolves the content that would be rendered for the given layer.\n */\nfunction useLegendContent(layer: AnyLayer): ReactNode | undefined {\n    const legendAttributes = useLegendAttributes(layer);\n    const legendUrl = useReactiveSnapshot(() => layer.legend, [layer]);\n    return useMemo(() => {\n        let renderedComponent: ReactNode | undefined;\n        if (legendAttributes?.Component) {\n            renderedComponent = <legendAttributes.Component layer={layer} />;\n        } else if (legendAttributes?.imageUrl) {\n            renderedComponent = <LegendImage layer={layer} imageUrl={legendAttributes.imageUrl} />;\n        } else {\n            if (legendUrl) {\n                renderedComponent = <LegendImage layer={layer} imageUrl={legendUrl} />;\n            }\n        }\n        return renderedComponent;\n    }, [legendUrl, legendAttributes, layer]);\n}\n\n/** Returns the top level operational layers in render order (topmost layer first). */\nfunction useLayers(map: MapModel): Layer[] {\n    return useReactiveSnapshot(() => {\n        const layers =\n            map.layers.getLayers({\n                sortByDisplayOrder: true,\n                includeInternalLayers: true //internal status is handled by LegendItems\n            }) ?? [];\n        layers.reverse(); // render topmost layer first\n        return layers;\n    }, [map]);\n}\n\n/**\n * Returns the child layers (sublayers or layers belonging to a GroupLayer) of the given layer.\n * Layers are returned in render order (topmost layer first).\n */\nfunction useChildLayers(layer: AnyLayer): AnyLayer[] {\n    return (\n        useReactiveSnapshot(() => {\n            const childLayers = layer.children?.getItems({\n                includeInternalLayers: true //internal status is handled by LegendItems\n            });\n            if (!childLayers) {\n                return undefined;\n            }\n\n            childLayers.reverse(); // render topmost layer first\n            return childLayers;\n        }, [layer]) ?? []\n    );\n}\n\nfunction useLegendAttributes(layer: AnyLayer): LegendItemAttributes | undefined {\n    return useReactiveSnapshot(\n        () => layer.attributes.legend as LegendItemAttributes | undefined,\n        [layer]\n    );\n}\n\nfunction getListMode(\n    listModeProp: ListMode | undefined,\n    isInternal: boolean,\n    hasLegendContent: boolean\n): ListMode {\n    if (listModeProp) {\n        return listModeProp; // Explicit value wins\n    }\n    if (isInternal) {\n        return \"hide\";\n    }\n    if (hasLegendContent) {\n        return \"hide-children\";\n    }\n    return \"show\";\n}\n\nfunction isBaseLayer(layer: AnyLayer) {\n    return isLayer(layer) && layer.isBaseLayer;\n}\n\nfunction slug(id: string) {\n    return id\n        .toLowerCase()\n        .replace(/[^a-z0-9 -]/g, \"\")\n        .replace(/\\s+/g, \"-\")\n        .replace(/-+/g, \"-\");\n}\n\nfunction useListMode(layer: AnyLayer): ListMode | undefined {\n    return useReactiveSnapshot(\n        () => (layer.attributes.legend as LegendItemAttributes | undefined)?.listMode,\n        [layer]\n    );\n}\n"],"names":[],"mappings":";;;;;;;;;;AA8EO,MAAM,MAAA,GAA0B,CAAC,KAAA,KAAU;AAC9C,EAAA,MAAM,EAAE,cAAA,GAAiB,KAAA,EAAM,GAAI,KAAA;AACnC,EAAA,MAAM,EAAE,cAAA,EAAe,GAAI,uBAAA,CAAwB,UAAU,KAAK,CAAA;AAClE,EAAA,MAAM,GAAA,GAAM,iBAAiB,KAAK,CAAA;AAElC,EAAA,uBACI,GAAA,CAAC,OAAK,GAAG,cAAA,EACL,8BAAC,UAAA,EAAA,EAAW,GAAA,EAAU,gBAAgC,CAAA,EAC1D,CAAA;AAER;AAEA,SAAS,WAAW,KAAA,EAA8D;AAC9E,EAAA,MAAM,EAAE,GAAA,EAAK,cAAA,EAAe,GAAI,KAAA;AAEhC,EAAA,MAAM,MAAA,GAAS,UAAU,GAAG,CAAA;AAC5B,EAAA,MAAM,eAAA,GAA+B,MAAA,CAAO,GAAA,CAAI,CAAC,KAAA,KAAU;AACvD,IAAA,uBACI,GAAA,CAAC,UAAA,EAAA,EAA0B,KAAA,EAAc,cAAA,EAAA,EAAxB,MAAM,EAAkD,CAAA;AAAA,EAEjF,CAAC,CAAA;AAED,EAAA,uBACI,GAAA;AAAA,IAAC,IAAA,CAAK,IAAA;AAAA,IAAL;AAAA,MAEG,EAAA,EAAG,IAAA;AAAA,MACH,SAAA,EAAU,mBAAA;AAAA,MACV,aAAA,EAAc,MAAA;AAAA,MACd,GAAA,EAAK,CAAA;AAAA,MAEJ,QAAA,EAAA;AAAA;AAAA,GACL;AAER;AAEA,SAAS,WAAW,KAAA,EAAgE;AAChF,EAAA,MAAM,EAAE,KAAA,EAAO,cAAA,EAAe,GAAI,KAAA;AAClC,EAAA,MAAM,EAAE,SAAA,EAAW,UAAA,EAAW,GAAI,oBAAoB,MAAM;AACxD,IAAA,OAAO;AAAA,MACH,WAAW,KAAA,CAAM,OAAA;AAAA,MACjB,YAAY,KAAA,CAAM;AAAA,KACtB;AAAA,EACJ,CAAA,EAAG,CAAC,KAAK,CAAC,CAAA;AACV,EAAA,MAAM,WAAA,GAAc,eAAe,KAAK,CAAA;AACxC,EAAA,MAAM,YAAA,GAAe,YAAY,KAAK,CAAA;AACtC,EAAA,MAAM,aAAA,GAAgB,iBAAiB,KAAK,CAAA;AAC5C,EAAA,MAAM,WAAW,WAAA,CAAY,YAAA,EAAc,UAAA,EAAY,CAAC,CAAC,aAAa,CAAA;AAEtE,EAAA,IAAI,CAAC,aAAa,QAAA,KAAa,MAAA,IAAW,CAAC,cAAA,IAAkB,WAAA,CAAY,KAAK,CAAA,EAAI;AAC9E,IAAA;AAAA,EACJ;AAGA,EAAA,IAAI,aAA0B,EAAC;AAC/B,EAAA,IAAI,aAAa,MAAA,EAAQ;AACrB,IAAA,UAAA,GAAa,WAAA,CAAY,GAAA,CAAI,CAAC,KAAA,qBAC1B,GAAA,CAAC,UAAA,EAAA,EAA0B,KAAA,EAAO,KAAA,EAAO,cAAA,EAAA,EAAxB,KAAA,CAAM,EAAkD,CAC5E,CAAA;AAAA,EACL;AAGA,EAAA,uBACI,IAAA,CAAA,QAAA,EAAA,EACI,QAAA,EAAA;AAAA,oBAAA,GAAA,CAAC,aAAA,EAAA,EAAc,KAAA,EAAc,OAAA,EAAS,aAAA,EAAe,CAAA;AAAA,IACpD;AAAA,GAAA,EACL,CAAA;AAER;AAEA,SAAS,cAAc,KAAA,EAAgD;AACnE,EAAA,MAAM,OAAO,OAAA,EAAQ;AAErB,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,EAAQ,GAAI,KAAA;AAC3B,EAAA,MAAM,SAAA,GAAY,YAAY,KAAK,CAAA;AACnC,EAAA,OAAO,OAAA,mBACH,IAAA,CAAC,GAAA,EAAA,EAAI,EAAA,EAAG,MAAK,SAAA,EAAW,UAAA,CAAW,aAAA,EAAe,CAAA,MAAA,EAAS,IAAA,CAAK,KAAA,CAAM,EAAE,CAAC,EAAE,CAAA,EACtE,QAAA,EAAA;AAAA,IAAA,SAAA;AAAA;AAAA,sBAEG,GAAA,CAAC,IAAA,EAAA,EAAK,EAAA,EAAG,GAAA,EAAK,QAAA,EAAA,IAAA,CAAK,cAAc,EAAE,EAAA,EAAI,cAAA,EAAgB,CAAA,EAAE;AAAA,QACzD,IAAA;AAAA,IACH;AAAA,GAAA,EACL,CAAA,GACA,MAAA;AACR;AAEA,SAAS,YAAY,KAAA,EAA8C;AAC/D,EAAA,MAAM,OAAO,OAAA,EAAQ;AAErB,EAAA,MAAM,EAAE,KAAA,EAAO,QAAA,EAAS,GAAI,KAAA;AAE5B,EAAA,MAAM,CAAC,OAAA,EAAS,UAAU,CAAA,GAAI,SAAS,KAAK,CAAA;AAC5C,EAAA,SAAA,CAAU,MAAM;AACZ,IAAA,UAAA,CAAW,KAAK,CAAA;AAAA,EACpB,CAAA,EAAG,CAAC,QAAQ,CAAC,CAAA;AAEb,EAAA,MAAM,OAAA,GAAU,QAAQ,MAAM;AAC1B,IAAA,IAAI,OAAA,EAAS;AACT,MAAA,uBACI,GAAA,CAAC,GAAA,EAAA,EACG,QAAA,kBAAA,IAAA,CAAC,IAAA,EAAA,EACG,QAAA,EAAA;AAAA,wBAAA,GAAA,CAAC,IAAA,EAAA,EAAK,EAAA,EAAI,CAAA,EACN,QAAA,kBAAA,GAAA,CAAC,mBAAgB,CAAA,EACrB,CAAA;AAAA,QACC,IAAA,CAAK,aAAA,CAAc,EAAE,EAAA,EAAI,iBAAiB;AAAA,OAAA,EAC/C,CAAA,EACJ,CAAA;AAAA,IAER;AAEA,IAAA,uBACI,GAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACG,IAAA,EAAK,MAAA;AAAA,QACL,IAAA,EAAK,MAAA;AAAA,QACL,GAAA,EAAK,QAAA;AAAA,QACL,GAAA,EAAK,IAAA,CAAK,aAAA,CAAc,EAAE,EAAA,EAAI,UAAA,EAAW,EAAG,EAAE,SAAA,EAAW,KAAA,CAAM,KAAA,EAAO,CAAA;AAAA,QACtE,SAAA,EAAW,oBAAA;AAAA,QACX,OAAA,EAAS,MAAM,UAAA,CAAW,IAAI;AAAA;AAAA,KAClC;AAAA,EAER,GAAG,CAAC,IAAA,EAAM,MAAM,KAAA,EAAO,QAAA,EAAU,OAAO,CAAC,CAAA;AAEzC,EAAA,4BACK,GAAA,EAAA,EACG,QAAA,EAAA;AAAA,oBAAA,GAAA,CAAC,IAAA,EAAA,EAAM,gBAAM,KAAA,EAAM,CAAA;AAAA,IAClB;AAAA,GAAA,EACL,CAAA;AAER;AAKA,SAAS,iBAAiB,KAAA,EAAwC;AAC9D,EAAA,MAAM,gBAAA,GAAmB,oBAAoB,KAAK,CAAA;AAClD,EAAA,MAAM,YAAY,mBAAA,CAAoB,MAAM,MAAM,MAAA,EAAQ,CAAC,KAAK,CAAC,CAAA;AACjE,EAAA,OAAO,QAAQ,MAAM;AACjB,IAAA,IAAI,iBAAA;AACJ,IAAA,IAAI,kBAAkB,SAAA,EAAW;AAC7B,MAAA,iBAAA,mBAAoB,GAAA,CAAC,gBAAA,CAAiB,SAAA,EAAjB,EAA2B,KAAA,EAAc,CAAA;AAAA,IAClE,CAAA,MAAA,IAAW,kBAAkB,QAAA,EAAU;AACnC,MAAA,iBAAA,mBAAoB,GAAA,CAAC,WAAA,EAAA,EAAY,KAAA,EAAc,QAAA,EAAU,iBAAiB,QAAA,EAAU,CAAA;AAAA,IACxF,CAAA,MAAO;AACH,MAAA,IAAI,SAAA,EAAW;AACX,QAAA,iBAAA,mBAAoB,GAAA,CAAC,WAAA,EAAA,EAAY,KAAA,EAAc,QAAA,EAAU,SAAA,EAAW,CAAA;AAAA,MACxE;AAAA,IACJ;AACA,IAAA,OAAO,iBAAA;AAAA,EACX,CAAA,EAAG,CAAC,SAAA,EAAW,gBAAA,EAAkB,KAAK,CAAC,CAAA;AAC3C;AAGA,SAAS,UAAU,GAAA,EAAwB;AACvC,EAAA,OAAO,oBAAoB,MAAM;AAC7B,IAAA,MAAM,MAAA,GACF,GAAA,CAAI,MAAA,CAAO,SAAA,CAAU;AAAA,MACjB,kBAAA,EAAoB,IAAA;AAAA,MACpB,qBAAA,EAAuB;AAAA;AAAA,KAC1B,KAAK,EAAC;AACX,IAAA,MAAA,CAAO,OAAA,EAAQ;AACf,IAAA,OAAO,MAAA;AAAA,EACX,CAAA,EAAG,CAAC,GAAG,CAAC,CAAA;AACZ;AAMA,SAAS,eAAe,KAAA,EAA6B;AACjD,EAAA,OACI,oBAAoB,MAAM;AACtB,IAAA,MAAM,WAAA,GAAc,KAAA,CAAM,QAAA,EAAU,QAAA,CAAS;AAAA,MACzC,qBAAA,EAAuB;AAAA;AAAA,KAC1B,CAAA;AACD,IAAA,IAAI,CAAC,WAAA,EAAa;AACd,MAAA,OAAO,MAAA;AAAA,IACX;AAEA,IAAA,WAAA,CAAY,OAAA,EAAQ;AACpB,IAAA,OAAO,WAAA;AAAA,EACX,CAAA,EAAG,CAAC,KAAK,CAAC,KAAK,EAAC;AAExB;AAEA,SAAS,oBAAoB,KAAA,EAAmD;AAC5E,EAAA,OAAO,mBAAA;AAAA,IACH,MAAM,MAAM,UAAA,CAAW,MAAA;AAAA,IACvB,CAAC,KAAK;AAAA,GACV;AACJ;AAEA,SAAS,WAAA,CACL,YAAA,EACA,UAAA,EACA,gBAAA,EACQ;AACR,EAAA,IAAI,YAAA,EAAc;AACd,IAAA,OAAO,YAAA;AAAA,EACX;AACA,EAAA,IAAI,UAAA,EAAY;AACZ,IAAA,OAAO,MAAA;AAAA,EACX;AACA,EAAA,IAAI,gBAAA,EAAkB;AAClB,IAAA,OAAO,eAAA;AAAA,EACX;AACA,EAAA,OAAO,MAAA;AACX;AAEA,SAAS,YAAY,KAAA,EAAiB;AAClC,EAAA,OAAO,OAAA,CAAQ,KAAK,CAAA,IAAK,KAAA,CAAM,WAAA;AACnC;AAEA,SAAS,KAAK,EAAA,EAAY;AACtB,EAAA,OAAO,EAAA,CACF,WAAA,EAAY,CACZ,OAAA,CAAQ,cAAA,EAAgB,EAAE,CAAA,CAC1B,OAAA,CAAQ,MAAA,EAAQ,GAAG,CAAA,CACnB,OAAA,CAAQ,OAAO,GAAG,CAAA;AAC3B;AAEA,SAAS,YAAY,KAAA,EAAuC;AACxD,EAAA,OAAO,mBAAA;AAAA,IACH,MAAO,KAAA,CAAM,UAAA,CAAW,MAAA,EAA6C,QAAA;AAAA,IACrE,CAAC,KAAK;AAAA,GACV;AACJ;;;;"}
+{"version":3,"file":"Legend.js","sources":["Legend.tsx"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Box, Icon, Image, List, Text } from \"@chakra-ui/react\";\nimport {\n    AnyLayer,\n    Layer,\n    MapModel,\n    MapModelProps,\n    isLayer,\n    useMapModelValue\n} from \"@open-pioneer/map\";\nimport { CommonComponentProps, useCommonComponentProps } from \"@open-pioneer/react-utils\";\nimport { useReactiveSnapshot } from \"@open-pioneer/reactivity\";\nimport { classNames } from \"@open-pioneer/react-utils\";\nimport { useIntl } from \"open-pioneer:react-hooks\";\nimport { ComponentType, FC, ReactNode, useEffect, useMemo, useState } from \"react\";\nimport { LuTriangleAlert } from \"react-icons/lu\";\n\n/**\n * Properties of a legend item React component.\n */\nexport interface LegendItemComponentProps {\n    /**\n     * Related layer of the legend.\n     */\n    layer: AnyLayer;\n}\n\n/**\n * Attributes of the legend attribute that can be specified on a layer.\n *\n * To show a legend for the layer, provide an imageUrl to an image to show\n * or provide a React component that will be rendered as a legend.\n *\n * LegendItemAttributes should be registered with a layer as the `\"legend\"` attribute.\n */\nexport interface LegendItemAttributes {\n    /**\n     * (Optional) URL to an image that will be shown as a legend for the layer.\n     */\n    imageUrl?: string;\n\n    /**\n     * (Optional) React component that will be shown as customized legend for the layer.\n     */\n    Component?: ComponentType<LegendItemComponentProps>;\n\n    /**\n     * (Optional) Additional property to control the display of the layer in the legend.\n     */\n    listMode?: ListMode;\n}\n\n/**\n * These are special properties for the Legend.\n */\nexport interface LegendProps extends CommonComponentProps, MapModelProps {\n    /**\n     * Specifies whether legend for active base layer is shown in the legend UI.\n     * Defaults to `false`.\n     */\n    showBaseLayers?: boolean;\n}\n\n/**\n * ListMode determines if a layer item is displayed in the Legend for the layer.\n * The option `\"hide-children\"` provides a shortcut to hide all child layers (e.g. sublayers of group) of the layer in the Legend.\n * It has the same effect as manually setting the `listMode` to `\"hide\"` on all child layers.\n *\n * ListMode has precedence over the layer's `internal` attribute but specifically configures the layer's display in the legend.\n *\n * By default, the list mode becomes `\"hide-children\"` if a layer has an associated legend.\n */\nexport type ListMode = \"show\" | \"hide\" | \"hide-children\";\n\n/**\n * The `Legend` component can be used to display the legend of layers that are visible in the map.\n */\nexport const Legend: FC<LegendProps> = (props) => {\n    const { showBaseLayers = false } = props;\n    const { containerProps } = useCommonComponentProps(\"legend\", props);\n    const map = useMapModelValue(props);\n\n    return (\n        <Box {...containerProps}>\n            <LegendList map={map} showBaseLayers={showBaseLayers} />\n        </Box>\n    );\n};\n\nfunction LegendList(props: { map: MapModel; showBaseLayers: boolean }): ReactNode {\n    const { map, showBaseLayers } = props;\n\n    const layers = useLayers(map);\n    const legendListItems: ReactNode[] = layers.map((layer) => {\n        return (\n            <LegendItem key={layer.id} layer={layer} showBaseLayers={showBaseLayers}></LegendItem>\n        );\n    });\n\n    return (\n        <List.Root\n            // Note: not using UnorderedList because it adds default margins\n            as=\"ul\"\n            className=\"legend-layer-list\"\n            listStyleType=\"none\"\n            gap={2}\n        >\n            {legendListItems}\n        </List.Root>\n    );\n}\n\nfunction LegendItem(props: { layer: AnyLayer; showBaseLayers: boolean }): ReactNode {\n    const { layer, showBaseLayers } = props;\n    const { isVisible, isInternal } = useReactiveSnapshot(() => {\n        return {\n            isVisible: layer.visible,\n            isInternal: layer.internal\n        };\n    }, [layer]);\n    const childLayers = useChildLayers(layer);\n    const listModeProp = useListMode(layer);\n    const legendContent = useLegendContent(layer);\n    const listMode = getListMode(listModeProp, isInternal, !!legendContent);\n\n    if (!isVisible || listMode === \"hide\" || (!showBaseLayers && isBaseLayer(layer))) {\n        return;\n    }\n\n    // legend items for all child layers (sublayers or layers in a group)\n    let childItems: ReactNode[] = [];\n    if (listMode === \"show\") {\n        childItems = childLayers.map((child) => (\n            <LegendItem key={child.id} layer={child} showBaseLayers={showBaseLayers} />\n        ));\n    }\n    // listMode: hide/hide-children -> childItems stays empty\n\n    return (\n        <>\n            <LegendContent layer={layer} content={legendContent} />\n            {childItems}\n        </>\n    );\n}\n\nfunction LegendContent(props: { layer: AnyLayer; content: ReactNode }) {\n    const intl = useIntl();\n\n    const { layer, content } = props;\n    const baseLayer = isBaseLayer(layer);\n    return content ? (\n        <Box as=\"li\" className={classNames(\"legend-item\", `layer-${slug(layer.id)}`)}>\n            {baseLayer ? (\n                /* Render additional text, if layer is a configured basemap */\n                <Text as=\"b\">{intl.formatMessage({ id: \"basemapLabel\" })}</Text>\n            ) : null}\n            {content}\n        </Box>\n    ) : undefined;\n}\n\nfunction LegendImage(props: { imageUrl: string; layer: AnyLayer }) {\n    const intl = useIntl();\n\n    const { layer, imageUrl } = props;\n\n    const [isError, setIsError] = useState(false);\n    useEffect(() => {\n        setIsError(false);\n    }, [imageUrl]);\n\n    const content = useMemo(() => {\n        if (isError) {\n            return (\n                <Box>\n                    <Text>\n                        <Icon me={2}>\n                            <LuTriangleAlert />\n                        </Icon>\n                        {intl.formatMessage({ id: \"fallbackLabel\" })}\n                    </Text>\n                </Box>\n            );\n        }\n\n        return (\n            <Image\n                maxW=\"none\"\n                maxH=\"none\"\n                src={imageUrl}\n                alt={intl.formatMessage({ id: \"altLabel\" }, { layerName: layer.title })}\n                className={\"legend-item__image\"}\n                onError={() => setIsError(true)}\n            />\n        );\n    }, [intl, layer.title, imageUrl, isError]);\n\n    return (\n        <Box>\n            <Text>{layer.title}</Text>\n            {content}\n        </Box>\n    );\n}\n\n/**\n * Resolves the content that would be rendered for the given layer.\n */\nfunction useLegendContent(layer: AnyLayer): ReactNode | undefined {\n    const legendAttributes = useLegendAttributes(layer);\n    const legendUrl = useReactiveSnapshot(() => layer.legend, [layer]);\n    return useMemo(() => {\n        let renderedComponent: ReactNode | undefined;\n        if (legendAttributes?.Component) {\n            renderedComponent = <legendAttributes.Component layer={layer} />;\n        } else if (legendAttributes?.imageUrl) {\n            renderedComponent = <LegendImage layer={layer} imageUrl={legendAttributes.imageUrl} />;\n        } else {\n            if (legendUrl) {\n                renderedComponent = <LegendImage layer={layer} imageUrl={legendUrl} />;\n            }\n        }\n        return renderedComponent;\n    }, [legendUrl, legendAttributes, layer]);\n}\n\n/** Returns the top level operational layers in render order (topmost layer first). */\nfunction useLayers(map: MapModel): Layer[] {\n    return useReactiveSnapshot(() => {\n        const layers =\n            map.layers.getLayers({\n                sortByDisplayOrder: true,\n                includeInternalLayers: true //internal status is handled by LegendItems\n            }) ?? [];\n        layers.reverse(); // render topmost layer first\n        return layers;\n    }, [map]);\n}\n\n/**\n * Returns the child layers (sublayers or layers belonging to a GroupLayer) of the given layer.\n * Layers are returned in render order (topmost layer first).\n */\nfunction useChildLayers(layer: AnyLayer): AnyLayer[] {\n    return (\n        useReactiveSnapshot(() => {\n            const childLayers = layer.children?.getItems({\n                includeInternalLayers: true //internal status is handled by LegendItems\n            });\n            if (!childLayers) {\n                return undefined;\n            }\n\n            childLayers.reverse(); // render topmost layer first\n            return childLayers;\n        }, [layer]) ?? []\n    );\n}\n\nfunction useLegendAttributes(layer: AnyLayer): LegendItemAttributes | undefined {\n    return useReactiveSnapshot(\n        () => layer.attributes.legend as LegendItemAttributes | undefined,\n        [layer]\n    );\n}\n\nfunction getListMode(\n    listModeProp: ListMode | undefined,\n    isInternal: boolean,\n    hasLegendContent: boolean\n): ListMode {\n    if (listModeProp) {\n        return listModeProp; // Explicit value wins\n    }\n    if (isInternal) {\n        return \"hide\";\n    }\n    if (hasLegendContent) {\n        return \"hide-children\";\n    }\n    return \"show\";\n}\n\nfunction isBaseLayer(layer: AnyLayer) {\n    return isLayer(layer) && layer.isBaseLayer;\n}\n\nfunction slug(id: string) {\n    return id\n        .toLowerCase()\n        .replace(/[^a-z0-9 -]/g, \"\")\n        .replace(/\\s+/g, \"-\")\n        .replace(/-+/g, \"-\");\n}\n\nfunction useListMode(layer: AnyLayer): ListMode | undefined {\n    return useReactiveSnapshot(\n        () => (layer.attributes.legend as LegendItemAttributes | undefined)?.listMode,\n        [layer]\n    );\n}\n"],"names":[],"mappings":";;;;;;;;;AA8EO,MAAM,MAAA,GAA0B,CAAC,KAAA,KAAU;AAC9C,EAAA,MAAM,EAAE,cAAA,GAAiB,KAAA,EAAM,GAAI,KAAA;AACnC,EAAA,MAAM,EAAE,cAAA,EAAe,GAAI,uBAAA,CAAwB,UAAU,KAAK,CAAA;AAClE,EAAA,MAAM,GAAA,GAAM,iBAAiB,KAAK,CAAA;AAElC,EAAA,uBACI,GAAA,CAAC,OAAK,GAAG,cAAA,EACL,8BAAC,UAAA,EAAA,EAAW,GAAA,EAAU,gBAAgC,CAAA,EAC1D,CAAA;AAER;AAEA,SAAS,WAAW,KAAA,EAA8D;AAC9E,EAAA,MAAM,EAAE,GAAA,EAAK,cAAA,EAAe,GAAI,KAAA;AAEhC,EAAA,MAAM,MAAA,GAAS,UAAU,GAAG,CAAA;AAC5B,EAAA,MAAM,eAAA,GAA+B,MAAA,CAAO,GAAA,CAAI,CAAC,KAAA,KAAU;AACvD,IAAA,uBACI,GAAA,CAAC,UAAA,EAAA,EAA0B,KAAA,EAAc,cAAA,EAAA,EAAxB,MAAM,EAAkD,CAAA;AAAA,EAEjF,CAAC,CAAA;AAED,EAAA,uBACI,GAAA;AAAA,IAAC,IAAA,CAAK,IAAA;AAAA,IAAL;AAAA,MAEG,EAAA,EAAG,IAAA;AAAA,MACH,SAAA,EAAU,mBAAA;AAAA,MACV,aAAA,EAAc,MAAA;AAAA,MACd,GAAA,EAAK,CAAA;AAAA,MAEJ,QAAA,EAAA;AAAA;AAAA,GACL;AAER;AAEA,SAAS,WAAW,KAAA,EAAgE;AAChF,EAAA,MAAM,EAAE,KAAA,EAAO,cAAA,EAAe,GAAI,KAAA;AAClC,EAAA,MAAM,EAAE,SAAA,EAAW,UAAA,EAAW,GAAI,oBAAoB,MAAM;AACxD,IAAA,OAAO;AAAA,MACH,WAAW,KAAA,CAAM,OAAA;AAAA,MACjB,YAAY,KAAA,CAAM;AAAA,KACtB;AAAA,EACJ,CAAA,EAAG,CAAC,KAAK,CAAC,CAAA;AACV,EAAA,MAAM,WAAA,GAAc,eAAe,KAAK,CAAA;AACxC,EAAA,MAAM,YAAA,GAAe,YAAY,KAAK,CAAA;AACtC,EAAA,MAAM,aAAA,GAAgB,iBAAiB,KAAK,CAAA;AAC5C,EAAA,MAAM,WAAW,WAAA,CAAY,YAAA,EAAc,UAAA,EAAY,CAAC,CAAC,aAAa,CAAA;AAEtE,EAAA,IAAI,CAAC,aAAa,QAAA,KAAa,MAAA,IAAW,CAAC,cAAA,IAAkB,WAAA,CAAY,KAAK,CAAA,EAAI;AAC9E,IAAA;AAAA,EACJ;AAGA,EAAA,IAAI,aAA0B,EAAC;AAC/B,EAAA,IAAI,aAAa,MAAA,EAAQ;AACrB,IAAA,UAAA,GAAa,WAAA,CAAY,GAAA,CAAI,CAAC,KAAA,qBAC1B,GAAA,CAAC,UAAA,EAAA,EAA0B,KAAA,EAAO,KAAA,EAAO,cAAA,EAAA,EAAxB,KAAA,CAAM,EAAkD,CAC5E,CAAA;AAAA,EACL;AAGA,EAAA,uBACI,IAAA,CAAA,QAAA,EAAA,EACI,QAAA,EAAA;AAAA,oBAAA,GAAA,CAAC,aAAA,EAAA,EAAc,KAAA,EAAc,OAAA,EAAS,aAAA,EAAe,CAAA;AAAA,IACpD;AAAA,GAAA,EACL,CAAA;AAER;AAEA,SAAS,cAAc,KAAA,EAAgD;AACnE,EAAA,MAAM,OAAO,OAAA,EAAQ;AAErB,EAAA,MAAM,EAAE,KAAA,EAAO,OAAA,EAAQ,GAAI,KAAA;AAC3B,EAAA,MAAM,SAAA,GAAY,YAAY,KAAK,CAAA;AACnC,EAAA,OAAO,OAAA,mBACH,IAAA,CAAC,GAAA,EAAA,EAAI,EAAA,EAAG,MAAK,SAAA,EAAW,UAAA,CAAW,aAAA,EAAe,CAAA,MAAA,EAAS,IAAA,CAAK,KAAA,CAAM,EAAE,CAAC,EAAE,CAAA,EACtE,QAAA,EAAA;AAAA,IAAA,SAAA;AAAA;AAAA,sBAEG,GAAA,CAAC,IAAA,EAAA,EAAK,EAAA,EAAG,GAAA,EAAK,QAAA,EAAA,IAAA,CAAK,cAAc,EAAE,EAAA,EAAI,cAAA,EAAgB,CAAA,EAAE;AAAA,QACzD,IAAA;AAAA,IACH;AAAA,GAAA,EACL,CAAA,GACA,MAAA;AACR;AAEA,SAAS,YAAY,KAAA,EAA8C;AAC/D,EAAA,MAAM,OAAO,OAAA,EAAQ;AAErB,EAAA,MAAM,EAAE,KAAA,EAAO,QAAA,EAAS,GAAI,KAAA;AAE5B,EAAA,MAAM,CAAC,OAAA,EAAS,UAAU,CAAA,GAAI,SAAS,KAAK,CAAA;AAC5C,EAAA,SAAA,CAAU,MAAM;AACZ,IAAA,UAAA,CAAW,KAAK,CAAA;AAAA,EACpB,CAAA,EAAG,CAAC,QAAQ,CAAC,CAAA;AAEb,EAAA,MAAM,OAAA,GAAU,QAAQ,MAAM;AAC1B,IAAA,IAAI,OAAA,EAAS;AACT,MAAA,uBACI,GAAA,CAAC,GAAA,EAAA,EACG,QAAA,kBAAA,IAAA,CAAC,IAAA,EAAA,EACG,QAAA,EAAA;AAAA,wBAAA,GAAA,CAAC,IAAA,EAAA,EAAK,EAAA,EAAI,CAAA,EACN,QAAA,kBAAA,GAAA,CAAC,mBAAgB,CAAA,EACrB,CAAA;AAAA,QACC,IAAA,CAAK,aAAA,CAAc,EAAE,EAAA,EAAI,iBAAiB;AAAA,OAAA,EAC/C,CAAA,EACJ,CAAA;AAAA,IAER;AAEA,IAAA,uBACI,GAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACG,IAAA,EAAK,MAAA;AAAA,QACL,IAAA,EAAK,MAAA;AAAA,QACL,GAAA,EAAK,QAAA;AAAA,QACL,GAAA,EAAK,IAAA,CAAK,aAAA,CAAc,EAAE,EAAA,EAAI,UAAA,EAAW,EAAG,EAAE,SAAA,EAAW,KAAA,CAAM,KAAA,EAAO,CAAA;AAAA,QACtE,SAAA,EAAW,oBAAA;AAAA,QACX,OAAA,EAAS,MAAM,UAAA,CAAW,IAAI;AAAA;AAAA,KAClC;AAAA,EAER,GAAG,CAAC,IAAA,EAAM,MAAM,KAAA,EAAO,QAAA,EAAU,OAAO,CAAC,CAAA;AAEzC,EAAA,4BACK,GAAA,EAAA,EACG,QAAA,EAAA;AAAA,oBAAA,GAAA,CAAC,IAAA,EAAA,EAAM,gBAAM,KAAA,EAAM,CAAA;AAAA,IAClB;AAAA,GAAA,EACL,CAAA;AAER;AAKA,SAAS,iBAAiB,KAAA,EAAwC;AAC9D,EAAA,MAAM,gBAAA,GAAmB,oBAAoB,KAAK,CAAA;AAClD,EAAA,MAAM,YAAY,mBAAA,CAAoB,MAAM,MAAM,MAAA,EAAQ,CAAC,KAAK,CAAC,CAAA;AACjE,EAAA,OAAO,QAAQ,MAAM;AACjB,IAAA,IAAI,iBAAA;AACJ,IAAA,IAAI,kBAAkB,SAAA,EAAW;AAC7B,MAAA,iBAAA,mBAAoB,GAAA,CAAC,gBAAA,CAAiB,SAAA,EAAjB,EAA2B,KAAA,EAAc,CAAA;AAAA,IAClE,CAAA,MAAA,IAAW,kBAAkB,QAAA,EAAU;AACnC,MAAA,iBAAA,mBAAoB,GAAA,CAAC,WAAA,EAAA,EAAY,KAAA,EAAc,QAAA,EAAU,iBAAiB,QAAA,EAAU,CAAA;AAAA,IACxF,CAAA,MAAO;AACH,MAAA,IAAI,SAAA,EAAW;AACX,QAAA,iBAAA,mBAAoB,GAAA,CAAC,WAAA,EAAA,EAAY,KAAA,EAAc,QAAA,EAAU,SAAA,EAAW,CAAA;AAAA,MACxE;AAAA,IACJ;AACA,IAAA,OAAO,iBAAA;AAAA,EACX,CAAA,EAAG,CAAC,SAAA,EAAW,gBAAA,EAAkB,KAAK,CAAC,CAAA;AAC3C;AAGA,SAAS,UAAU,GAAA,EAAwB;AACvC,EAAA,OAAO,oBAAoB,MAAM;AAC7B,IAAA,MAAM,MAAA,GACF,GAAA,CAAI,MAAA,CAAO,SAAA,CAAU;AAAA,MACjB,kBAAA,EAAoB,IAAA;AAAA,MACpB,qBAAA,EAAuB;AAAA;AAAA,KAC1B,KAAK,EAAC;AACX,IAAA,MAAA,CAAO,OAAA,EAAQ;AACf,IAAA,OAAO,MAAA;AAAA,EACX,CAAA,EAAG,CAAC,GAAG,CAAC,CAAA;AACZ;AAMA,SAAS,eAAe,KAAA,EAA6B;AACjD,EAAA,OACI,oBAAoB,MAAM;AACtB,IAAA,MAAM,WAAA,GAAc,KAAA,CAAM,QAAA,EAAU,QAAA,CAAS;AAAA,MACzC,qBAAA,EAAuB;AAAA;AAAA,KAC1B,CAAA;AACD,IAAA,IAAI,CAAC,WAAA,EAAa;AACd,MAAA,OAAO,MAAA;AAAA,IACX;AAEA,IAAA,WAAA,CAAY,OAAA,EAAQ;AACpB,IAAA,OAAO,WAAA;AAAA,EACX,CAAA,EAAG,CAAC,KAAK,CAAC,KAAK,EAAC;AAExB;AAEA,SAAS,oBAAoB,KAAA,EAAmD;AAC5E,EAAA,OAAO,mBAAA;AAAA,IACH,MAAM,MAAM,UAAA,CAAW,MAAA;AAAA,IACvB,CAAC,KAAK;AAAA,GACV;AACJ;AAEA,SAAS,WAAA,CACL,YAAA,EACA,UAAA,EACA,gBAAA,EACQ;AACR,EAAA,IAAI,YAAA,EAAc;AACd,IAAA,OAAO,YAAA;AAAA,EACX;AACA,EAAA,IAAI,UAAA,EAAY;AACZ,IAAA,OAAO,MAAA;AAAA,EACX;AACA,EAAA,IAAI,gBAAA,EAAkB;AAClB,IAAA,OAAO,eAAA;AAAA,EACX;AACA,EAAA,OAAO,MAAA;AACX;AAEA,SAAS,YAAY,KAAA,EAAiB;AAClC,EAAA,OAAO,OAAA,CAAQ,KAAK,CAAA,IAAK,KAAA,CAAM,WAAA;AACnC;AAEA,SAAS,KAAK,EAAA,EAAY;AACtB,EAAA,OAAO,EAAA,CACF,WAAA,EAAY,CACZ,OAAA,CAAQ,cAAA,EAAgB,EAAE,CAAA,CAC1B,OAAA,CAAQ,MAAA,EAAQ,GAAG,CAAA,CACnB,OAAA,CAAQ,OAAO,GAAG,CAAA;AAC3B;AAEA,SAAS,YAAY,KAAA,EAAuC;AACxD,EAAA,OAAO,mBAAA;AAAA,IACH,MAAO,KAAA,CAAM,UAAA,CAAW,MAAA,EAA6C,QAAA;AAAA,IACrE,CAAC,KAAK;AAAA,GACV;AACJ;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@open-pioneer/legend",
-  "version": "1.3.0-dev.20260512095810",
+  "version": "1.3.0",
   "description": "This package provides a legend UI component that allows a user to see legend information for layers in the map.",
   "keywords": [
     "open-pioneer-trails"
@@ -14,15 +14,14 @@
     "directory": "src/packages/legend"
   },
   "dependencies": {
-    "@chakra-ui/react": "^3.34.0",
-    "@open-pioneer/react-utils": "4.6.0-dev.20260420101935",
-    "@open-pioneer/runtime": "4.6.0-dev.20260420101935",
-    "classnames": "^2.5.1",
+    "@chakra-ui/react": "^3.35.0",
+    "@open-pioneer/react-utils": "^4.6.0",
+    "@open-pioneer/runtime": "^4.6.0",
     "ol": "^10.9.0",
-    "react": "^19.2.5",
-    "@open-pioneer/reactivity": "4.6.0-dev.20260420101935",
+    "react": "^19.2.6",
+    "@open-pioneer/reactivity": "^4.6.0",
     "react-icons": "^5.6.0",
-    "@open-pioneer/map": "1.3.0-dev.20260512095810"
+    "@open-pioneer/map": "1.3.0"
   },
   "exports": {
     "./package.json": "./package.json",
@@ -43,6 +42,6 @@
       "references": []
     },
     "properties": [],
-    "packageFormatVersion": "1.0.0"
+    "packageFormatVersion": "1.0.1"
   }
 }