Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos in getting started docs #1013

Merged
merged 2 commits into from
Aug 3, 2022
Merged

Fix typos in getting started docs #1013

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a60c44
Fix typos in start-introduction.md
jacobtylerwalls Jul 25, 2022
3a3d0e3
Fix typo in start-installation.mdx
jacobtylerwalls Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/website/docs/start-installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Before using React Leaflet, you must setup your project following [Leaflet's Qui

### Using ESM imports

React Leaflet export [ES Modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) that can be imported by URL, notably from CDNs such as [esm.sh](https://esm.sh/):
React Leaflet exports [ES Modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) that can be imported by URL, notably from CDNs such as [esm.sh](https://esm.sh/):

```js
import { MapContainer } from 'https://cdn.esm.sh/react-leaflet/MapContainer'
Expand Down
4 changes: 2 additions & 2 deletions packages/website/docs/start-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ React only renders a `<div>` element when rendering the [`MapContainer` componen

The properties passed to the components are used to create the relevant Leaflet instance when the component is rendered the first time and should be treated as **immutable by default**.

During the first render, all these properties should be supported as they are by Leaflet, **however they will not be updated in the UI when they change** unless they are explicitely documented as being **mutable**.
During the first render, all these properties should be supported as they are by Leaflet, **however they will not be updated in the UI when they change** unless they are explicitly documented as being **mutable**.

Mutable properties changes are compared by reference (unless stated otherwise) and are applied calling the relevant method on the Leaflet element instance.

### Leaflet elements references

Unless stated otherwise, all components exported by React Leaflet support [refs](https://reactjs.org/docs/glossary.html#refs) exposing the created Leaflet element instance or DOM element (for panes).

This allows applications to access Leaflet's imperative APIs when required, but may create inconsitencies with props being set and should be used carefully.
This allows applications to access Leaflet's imperative APIs when required, but may create inconsistencies with props being set and should be used carefully.

### React context

Expand Down