•  


GitHub - googlemaps/react-wrapper: Wrap React components with this libary to load the Google Maps JavaScript API.
Skip to content

googlemaps/react-wrapper

Repository files navigation

Google Maps JavaScript API React Wrapper

npm Build Release codecov GitHub contributors semantic-release

Description

Wrap React components with this library to load the Google Maps JavaScript API.

import
 {
 Wrapper
 }
 from
 "@googlemaps/react-wrapper"
;


const
 MyApp
 =
 (
)
 =>
 (

  <
Wrapper
 apiKey
=
{
"YOUR_API_KEY"
}
>

    <
MyMapComponent
 /
>

  <
/
Wrapper
>

)
;

The preceding example will not render any elements unless the Google Maps JavaScript API is successfully loaded. To handle error cases and the time until load is complete, it is recommended to provide render props.

import
 {
 Wrapper
,
 Status
 }
 from
 "@googlemaps/react-wrapper"
;


const
 render
 =
 (
status
)
 =>
 {

  switch
 (
status
)
 {

    case
 Status
.
LOADING
:
      
return
 <
Spinner
 /
>
;

    case
 Status
.
FAILURE
:
      
return
 <
ErrorComponent
 /
>
;

    case
 Status
.
SUCCESS
:
      
return
 <
MyMapComponent
 /
>
;

  }

}
;


const
 MyApp
 =
 (
)
 =>
 <
Wrapper
 apiKey
=
{
"YOUR_API_KEY"
}
 render
=
{
render
}
 /
>
;

When combining children and render props, the children will render on success and the render prop will be executed for other status values.

import
 {
 Wrapper
,
 Status
 }
 from
 "@googlemaps/react-wrapper"
;


const
 render
 =
 (
status
: 
Status
)
: 
ReactElement
 =>
 {

  if
 (
status
 ===
 Status
.
FAILURE
)
 return
 <
ErrorComponent
 /
>
;

  return
 <
Spinner
 /
>
;

}
;


const
 MyApp
 =
 (
)
 =>
 (

  <
Wrapper
 apiKey
=
{
"YOUR_API_KEY"
}
 render
=
{
render
}
>

    <
MyMapComponent
 /
>

  <
/
Wrapper
>

)
;

@googlemaps/js-api-loader

This wrapper uses @googlemaps/js-api-loader to load the Google Maps JavaScript API. This library uses a singleton pattern and will not attempt to load the library more than once. All options accepted by @googlemaps/js-api-loader are also accepted as props to the wrapper component.

MyMapComponent

The following snippets demonstrates the usage of useRef and useEffect hooks with Google Maps.

function
 MyMapComponent
(
{

  center
,

  zoom
,

}
: 
{

  center
: 
google
.
maps
.
LatLngLiteral
;

  zoom
: 
number
;

}
)
 {

  const
 ref
 =
 useRef
(
)
;


  useEffect
(
(
)
 =>
 {

    new
 window
.
google
.
maps
.
Map
(
ref
.
current
,
 {

      center
,

      zoom
,

    }
)
;

  }
)
;


  return
 <
div
 ref
=
{
ref
}
 id
=
"map"
 /
>
;

}

Examples

See the examples folder for additional usage patterns.

Install

Available via npm as the package @googlemaps/react-wrapper .

npm i @googlemaps/react-wrapper

or

yarn add @googlemaps/react-wrapper

For TypeScript support additionally install type definitions.

npm i -D @types/google.maps

or

yarn add -D @types/google.maps

Documentation

The reference documentation can be found at this link .

Support

This library is community supported. We're comfortable enough with the stability and features of the library that we want you to build real production applications on it.

If you find a bug, or have a feature suggestion, please log an issue . If you'd like to contribute, please read How to Contribute .

- "漢字路" 한글한자자동변환 서비스는 교육부 고전문헌국역지원사업의 지원으로 구축되었습니다.
- "漢字路" 한글한자자동변환 서비스는 전통문화연구회 "울산대학교한국어처리연구실 옥철영(IT융합전공)교수팀"에서 개발한 한글한자자동변환기를 바탕하여 지속적으로 공동 연구 개발하고 있는 서비스입니다.
- 현재 고유명사(인명, 지명등)을 비롯한 여러 변환오류가 있으며 이를 해결하고자 많은 연구 개발을 진행하고자 하고 있습니다. 이를 인지하시고 다른 곳에서 인용시 한자 변환 결과를 한번 더 검토하시고 사용해 주시기 바랍니다.
- 변환오류 및 건의,문의사항은 juntong@juntong.or.kr로 메일로 보내주시면 감사하겠습니다. .
Copyright ⓒ 2020 By '전통문화연구회(傳統文化硏究會)' All Rights reserved.
 한국   대만   중국   일본