UNPKG

@uiw/react-baidu-map-info-window

Version:

Baidu Map info-window Components for React.

235 lines (207 loc) 15.2 kB
<div markdown="1"> <sup>使用 <a href="https://wangchujiang.com/#/app" target="_blank">我的应用</a> 也是一种 <a href="https://wangchujiang.com/#/sponsor" target="_blank">支持</a> 我的方式:</sup> <br> <a target="_blank" href="https://apps.apple.com/app/Vidwall/6747587746" title="Vidwall for macOS"><img align="center" alt="Vidwall" height="52" width="52" src="https://github.com/user-attachments/assets/7b5df70a-ed91-4d4b-85be-f00e60a09ce9"></a> <a target="_blank" href="https://wangchujiang.com/mousio-hint/" title="Mousio Hint for macOS"><img align="center" alt="Mousio Hint" height="52" width="52" src="https://github.com/user-attachments/assets/3c0af128-0cef-44e5-a8db-4741dc5a6690"></a> <a target="_blank" href="https://apps.apple.com/app/6746747327" title="Mousio for macOS"><img align="center" alt="Mousio" height="52" width="52" src="https://github.com/user-attachments/assets/9edf61ff-5a6c-4676-9cc2-8fd3c1ad0dfb"></a> <a target="_blank" href="https://apps.apple.com/app/6745227444" title="Musicer for macOS"><img align="center" alt="Musicer" height="52" width="52" src="https://github.com/user-attachments/assets/b7abfba8-88ff-4c86-a125-43073d5aef22"></a> <a target="_blank" href="https://apps.apple.com/app/6743841447" title="Audioer for macOS"><img align="center" alt="Audioer" height="52" width="52" src="https://github.com/user-attachments/assets/7a836865-8c90-4119-87bc-19e06a76c957"></a> <a target="_blank" href="https://apps.apple.com/app/6744690194" title="FileSentinel for macOS"><img align="center" alt="FileSentinel" height="52" width="52" src="https://github.com/user-attachments/assets/28bce2cc-290e-45bf-9068-585ff6ecafe9"></a> <a target="_blank" href="https://apps.apple.com/app/6743495172" title="FocusCursor for macOS"><img align="center" alt="FocusCursor" height="52" width="52" src="https://github.com/user-attachments/assets/d543668a-737b-4853-a6bb-eaa269e69836"></a> <a target="_blank" href="https://apps.apple.com/app/6742680573" title="Videoer for macOS"><img align="center" alt="Videoer" height="52" width="52" src="https://github.com/user-attachments/assets/10ffb0f1-0625-40d6-93f1-2c2496592595"></a> <a target="_blank" href="https://apps.apple.com/app/6740425504" title="KeyClicker for macOS"><img align="center" alt="KeyClicker" height="52" width="52" src="https://github.com/user-attachments/assets/5a19fcb9-cb81-4855-b4ea-31c604d9612a"></a> <a target="_blank" href="https://apps.apple.com/app/6739052447" title="DayBar for macOS"><img align="center" alt="DayBar" height="52" width="52" src="https://github.com/user-attachments/assets/771b608d-594c-492d-8532-d9231e383f5b"></a> <a target="_blank" href="https://apps.apple.com/app/6739444407" title="Iconed for macOS"><img align="center" alt="Iconed" height="52" width="52" src="https://github.com/user-attachments/assets/8a35dc7b-4faf-4e2a-9311-f66d6844a896"></a> <a target="_blank" href="https://apps.apple.com/app/6737160756" title="RightMenu Master for macOS"><img align="center" alt="RightMenu Master" height="52" width="52" src="https://github.com/user-attachments/assets/39a76541-71bf-4de7-a01c-c62f0557dff5"></a> <a target="_blank" href="https://apps.apple.com/app/6723903021" title="Paste Quick for macOS"><img align="center" alt="Quick RSS" height="52" width="52" src="https://github.com/user-attachments/assets/bdaad5b7-9810-44ce-8f17-8410864465d2"></a> <a target="_blank" href="https://apps.apple.com/app/6670696072" title="Quick RSS for macOS/iOS"><img align="center" alt="Quick RSS" height="52" width="52" src="https://github.com/user-attachments/assets/374106b5-a448-4d1d-9ccb-b04b6bc681ed"></a> <a target="_blank" href="https://apps.apple.com/app/6670167443" title="Web Serve for macOS"><img align="center" alt="Web Serve" height="52" width="52" src="https://github.com/user-attachments/assets/e1d9f76f-0f3d-4ba5-8a15-253ee173bb1c"></a> <a target="_blank" href="https://apps.apple.com/app/6503953628" title="Copybook Generator for macOS/iOS"><img align="center" alt="Copybook Generator" height="52" width="52" src="https://github.com/jaywcjlove/jaywcjlove/assets/1680273/b90e42ff-158b-4534-82ca-5898fd0e8d73"></a> <a target="_blank" href="https://apps.apple.com/app/6471227008" title="DevTutor for macOS/iOS"><img align="center" alt="DevTutor for SwiftUI" height="52" width="52" src="https://github.com/jaywcjlove/jaywcjlove/assets/1680273/f15c154d-0192-48eb-8e0e-9e245ffd974a"></a> <a target="_blank" href="https://apps.apple.com/app/6479819388" title="RegexMate for macOS/iOS"><img align="center" alt="RegexMate" height="52" width="52" src="https://github.com/jaywcjlove/jaywcjlove/assets/1680273/aabe5aa9-9a96-4390-8bed-c3e4023d0dea"></a> <a target="_blank" href="https://apps.apple.com/app/6479194014" title="Time Passage for macOS/iOS"><img align="center" alt="Time Passage" height="52" width="52" src="https://github.com/jaywcjlove/time-passage/assets/1680273/6f30e429-e6f3-4dbe-9921-a5effe2a05e9"></a> <a target="_blank" href="https://apps.apple.com/app/6478772538" title="IconizeFolder for macOS"><img align="center" alt="Iconize Folder" height="52" width="52" src="https://github.com/jaywcjlove/jaywcjlove/assets/1680273/fa9d8b9c-1e51-4ded-877c-fa5b21c47220"></a> <a target="_blank" href="https://apps.apple.com/app/6478511402" title="Textsound Saver for macOS/iOS"><img align="center" alt="Textsound Saver" height="52" width="52" src="https://github.com/jaywcjlove/jaywcjlove/assets/1680273/0595e842-980b-4574-8891-a8ba853a08be"></a> <a target="_blank" href="https://apps.apple.com/app/6476924627" title="Create Custom Symbols for macOS"><img align="center" alt="Create Custom Symbols" height="52" width="52" src="https://github.com/jaywcjlove/jaywcjlove/assets/1680273/8cd022ce-a3f1-4e89-b7c6-6fbd0d4db77c"></a> <a target="_blank" href="https://apps.apple.com/app/6476452351" title="DevHub for macOS"><img align="center" alt="DevHub" height="52" width="52" src="https://github.com/user-attachments/assets/4a44a4fd-67ce-430b-af0a-72f18feaa47d"></a> <a target="_blank" href="https://apps.apple.com/app/6476400184" title="Resume Revise for macOS"><img align="center" alt="Resume Revise" height="52" width="52" src="https://github.com/jaywcjlove/jaywcjlove/assets/1680273/c9954a20-1905-48de-bdf8-d71837974aa2"></a> <a target="_blank" href="https://apps.apple.com/app/6472593276" title="Palette Genius for macOS"><img align="center" alt="Palette Genius" height="52" width="52" src="https://github.com/jaywcjlove/jaywcjlove/assets/1680273/27340413-d355-45b2-8f6f-6ac37682d957"></a> <a target="_blank" href="https://apps.apple.com/app/6470879005" title="Symbol Scribe for macOS"><img align="center" alt="Symbol Scribe" height="52" width="52" src="https://github.com/jaywcjlove/jaywcjlove/assets/1680273/c7249f05-fa70-4def-a1e9-571d5f171fc9"></a> <br/> </div> <hr> InfoWindow 信息窗口 === [![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor) [![npm version](https://img.shields.io/npm/v/@uiw/react-baidu-map-info-window.svg)](https://www.npmjs.com/package/@uiw/react-baidu-map-info-window) [![Downloads](https://img.shields.io/npm/dm/@uiw/react-baidu-map-info-window.svg?style=flat)](https://www.npmjs.com/package/@uiw/react-baidu-map-info-window) 表示地图上包含信息的窗口。 ```jsx import { InfoWindow, useInfoWindow } from '@uiw/react-baidu-map'; // 或者单独安装使用 import InfoWindow, { useInfoWindow } from '@uiw/react-baidu-map-info-window'; ``` ### 基本用法 ```jsx mdx:preview import React, { useState } from 'react'; import { Map, InfoWindow, APILoader } from '@uiw/react-baidu-map'; const Example = () => { const [visiable, setVisiable] = useState(true); const [ isOpen, setIsOpen ] = useState(true); const [ content, setContent ] = useState('上海市 <del>青浦区</del> 徐泾镇盈港东路'); function infoWindowRef(props) { if (props && props.infoWindow) { console.log('infoWindow:', props.infoWindow, props.map, props.BMap); } } return ( <> <button onClick={() => setIsOpen(!isOpen)}>{isOpen ? '关闭' : '打开'} isOpen={String(isOpen)}</button> <button onClick={() => setVisiable(!visiable)}>{visiable ? '隐藏' : '显示'}visiable={String(visiable)}</button> <input value={content} onChange={(e) => setContent(e.target.value)} /> <Map zoom={13} center={{ lng: 121.460977, lat: 31.227906 }}> <InfoWindow ref={infoWindowRef} visiable={visiable} isOpen={isOpen} onClose={() => { console.log(':onClose'); }} position={{ lng: 121.501365, lat: 31.224942 }} content={content} title="地址信息一" /> </Map> </> ); } const Demo = () => ( <div style={{ width: '100%', height: '350px' }}> <APILoader akay="eYpCTECSntZmw0WyoQ7zFpCRR9cpgHFG"> <Example /> </APILoader> </div> ); export default Demo; ``` ### ~~`content`~~ -> `children` 支持 `JSX.Element` 通过 `children` 支持 `JSX.Element` 的方式展现内容,因为窗口信息内容通过 `content` 展示内容,它支持 `string/HTMLElement` 添加事件并不方便。 > 🚧 如果同时设置了 `content` 属性且有 `children`,`content` 将失效被忽略。 <!--rehype:style=border-left: 8px solid #ffe564; background-color: #ffe56440; padding: 12px 16px;--> <!--rehype--> ```jsx mdx:preview import React, { useState } from 'react'; import { Map, InfoWindow, APILoader } from '@uiw/react-baidu-map'; const Example = () => { const [visiable, setVisiable] = useState(true); const [ isOpen, setIsOpen ] = useState(true); const [ count, setCount ] = useState(0); return ( <> <button onClick={() => setIsOpen(!isOpen)}>{isOpen ? '关闭' : '打开'} isOpen={String(isOpen)}</button> <button onClick={() => setVisiable(!visiable)}>{visiable ? '隐藏' : '显示'}visiable={String(visiable)}</button> <Map zoom={13} center={{ lng: 121.460977, lat: 31.227906 }}> <InfoWindow visiable={visiable} isOpen={isOpen} onClose={() => { console.log(':onClose'); }} position={{ lng: 121.501365, lat: 31.224942 }} title={<div>地址信息二</div>} content="test" > <div> 上海市 <del>青浦区</del> 徐泾镇盈港东路 Good! <br/> <button onClick={() => setCount(count+1)}>{count} Count={String(count)}</button> </div> </InfoWindow> </Map> </> ); } const Demo = () => ( <div style={{ width: '100%', height: '350px' }}> <APILoader akay="eYpCTECSntZmw0WyoQ7zFpCRR9cpgHFG"> <Example /> </APILoader> </div> ); export default Demo; ``` ### 使用 hooks `infoWindow`, `setInfoWindow`, `isOpen`, `setIsOpen` ```jsx mdx:preview import React, { useRef, useState, useEffect } from 'react'; import { Map, Provider, useMap, InfoWindow, useInfoWindow, APILoader } from '@uiw/react-baidu-map'; const Example = () => { const divElm = useRef(null); const { setContainer, map } = useMap({ zoom: 13, center: { lng: 121.460977, lat: 31.227906 }, widget: ['GeolocationControl', 'NavigationControl'] }); const [title, setTitle] = useState('地址信息二'); const position = { lng: 121.501365, lat: 31.224942 }; const { infoWindow, isOpen, setIsOpen, Portal, PortalTitle } = useInfoWindow({ position, enableCloseOnClick: false, isOpen: true, // content: '上海市 <del>青浦区</del> 徐泾镇盈港东路', // title, onClose: () => { console.log('onClose:'); } }); useEffect(() => { if (divElm.current) { setContainer(divElm.current); } }); return ( <> <button onClick={() => setIsOpen(!isOpen)}>{isOpen ? '显示' : '隐藏'}</button> <input value={title} onChange={(e) => setTitle(e.target.value)} /> <div ref={divElm} style={{ height: 350 }} /> <Portal>上海市 <del>青浦区</del> 徐泾镇盈港东路</Portal> <PortalTitle> {title} </PortalTitle> </> ) } const Demo = () => { return ( <div style={{ width: '100%' }}> <APILoader akay="eYpCTECSntZmw0WyoQ7zFpCRR9cpgHFG"> <Provider> <Example /> </Provider> </APILoader> </div> ) }; export default Demo; ``` ### Props | 参数 | 说明 | 类型 | 默认值 | | ----- | ----- | ----- | ----- | | position | **`必填`**<!--rehype:style=background-color: #ffe56440;--> 指定的经度和纬度创建一个地理点坐标 | `Point` | - | | content | 展示文本内容,支持 `HTML` 内容字符串 | `string` | - | | children | 展示文本内容,_🚧 添加 `children` 的时候 `content` 将失效_<!--rehype:style=background-color: #ffe56440;-->。 | `JSX.Element` | - | | isOpen | 窗口是否打开 | `Point` | - | | visiable | 覆盖物是否可见。此属性来自继承 `Overlay` 实例对象。 | `boolean` | - | | width | 信息窗宽度,单位像素。取值范围:`0`, `220 - 730`。如果您指定宽度为 `0`,则信息窗口的宽度将按照其内容自动调整 | `number` | `true` | | height | 信息窗高度,单位像素。取值范围:`0`, `60 - 650`。如果您指定宽度为 `0`,则信息窗口的宽度将按照其内容自动调整 | `number` | - | | maxWidth | 信息窗最大化时的宽度,单位像素。取值范围:`220 - 730` | `number` | - | | offset | 信息窗位置偏移值。默认情况下在地图上打开的信息窗底端的尖角将指向其地理坐标,在标注上打开的信息窗底端尖角的位置取决于标注所用图标的 infoWindowOffset 属性值,您可以为信息窗添加偏移量来改变默认位置 | `Size` | - | | maxContent | 信息窗口最大化时所显示内容,支持HTML内容 | `string` | - | | title | 信息窗标题文字,支持 `HTML` 内容 | `string` | - | | message | 自定义部分的短信内容,可选项。完整的短信内容包括:自定义部分+位置链接,不设置时,显示默认短信内容。短信内容最长为140个字 | `string` | - | | enableAutoPan | 是否开启信息窗口打开时地图自动移动(默认开启) | `boolean` | - | | enableCloseOnClick | 是否开启点击地图关闭信息窗口(默认开启) | `boolean` | - | | enableMaximize | 启用窗口最大化功能。需要设置最大化后信息窗口里的内容,该接口才生效 | `boolean` | - | ### 事件 | 参数 | 说明 | 类型 | | ----- | ----- | ----- | | onClose | 信息窗口被关闭时触发此事件 | (event: { type: string, target: any, point: Point }) => void; | | onOpen | 信息窗口被打开时触发此事件 | (event: { type: string, target: any, point: Point }) => void; | | onMaximize | 信息窗口最大化后触发此事件 | (event: { type: string, target: any }) => void; | | onRestore | 信息窗口还原时触发此事件 | (event: { type: string, target: any }) => void; | | onClickclose | 点击信息窗口的关闭按钮时触发此事件 | (event: { type: string, target: any }) => void; |