viewscreen-geojson

v1.0.0

Published

a month ago

viewscreen component for geojson and topojson

Downloads

0High
0Medium
0Low

wooorm

kmck

remcohaszing

geojson github topojson viewscreen

viewscreen-geojson

Viewscreen component for geojson and topojson.

What is this?

This library can run inside an <iframe>, with some skeleton HTML. Then, from the outside, you can embed that frame, and send messages to it, to display geojson or topojson on a map.

This behavior is specific to github.com that works in comments and files. Using <iframe>s is a way to create components agnostic to a framework: you can use this with plain JavaScript or with React, for example.

This library is part of a monorepo rehype-github. See its readme for more info.

When should I use this?

You can use this library when you want to match how github.com works or when you want to build similar pipelines.

This library is useful if you want to user content to include maps.

Install

This package is ESM only. In browsers with esm.sh:

<script type="module">
  import {viewscreenGeojson} from 'https://esm.sh/viewscreen-geojson@1?bundle'
</script>

Use

Say our file viewscreen-geojson.html looks as follows:

<!doctype html>
<html lang=en>
<meta content=initial-scale=1,width=device-width name=viewport>
<meta charset=utf8>
<title>viewscreen: geojson</title>
<link href=https://esm.sh/[email protected]/dist/leaflet.css rel=stylesheet>
<link href=https://esm.sh/[email protected]/dist/MarkerCluster.css rel=stylesheet>
<link href=https://esm.sh/[email protected]/dist/MarkerCluster.Default.css rel=stylesheet>
<style>/* … */</style>
<script type=module>
  import {viewscreenGeojson} from 'https://esm.sh/viewscreen-geojson@1?bundle'

  const id = window.location.hash.slice(1)
  if (!id) throw new Error('Expected `id` in hash')
  const parent = window.parent
  if (!parent) throw new Error('Expected parent window')

  const viewer = viewscreenGeojson(document.body, {
    onReject(value) {
      parent.postMessage({id, type: 'reject', value})
    },
    onSizeSuggestion(width, height) {
      parent.postMessage({id, type: 'resize', value: {height, width}})
    },
    onResolve() {
      parent.postMessage({id, type: 'resolve'})
    }
  })

  window.addEventListener('message', function (event) {
    if (event.data.type === 'content') {
      viewer.change(event.data.value)
    }
  })
</script>

…and a file index.html looks as follows:

<!doctype html>
<html lang=en>
<meta charset=utf8>
<meta content=initial-scale=1,width=device-width name=viewport>
<title>example</title>
<link href=https://esm.sh/github-markdown-css@5/github-markdown.css rel=stylesheet>
<style>/* … */</style>
<div class=markdown-body>
<pre><code class=language-geojson>{
  "type": "Feature",
  "geometry": {"type": "Point", "coordinates": [125.6, 10.1]},
  "properties": {"name": "Dinagat Islands"}
}
</code></pre>
</div>
<script type=module>
  const types = {
    geojson: '/viewscreen-geojson.html',
    topojson: '/viewscreen-geojson.html'
  }

  const viewscreens = new Map()

  /**
   * Handle a message from any viewscreen iframe.
   */
  window.addEventListener('message', function (event) {
    if (event.data.type === 'resize') {
      // We use unique names, but not bad to handle arrays.
      const nodes = document.getElementsByName(event.data.id)

      for (const node of nodes) {
        node.setAttribute('style', `height:${event.data.value.height}px`)
      }
    } else if (event.data.type === 'resolve') {
      const viewscreen = viewscreens.get(event.data.id)
      if (!viewscreen) throw new Error('Expected viewscreen')
      // Note: this never happens.
      // When `reject` is added to the DOM, it replaces the frame, which
      // offloads it, so `resolve` will never happen.
      if (viewscreen.reject.parentElement) {
        viewscreen.reject.replaceWith(viewscreen.resolve)
      }
    } else if (event.data.type === 'reject') {
      const viewscreen = viewscreens.get(event.data.id)
      if (!viewscreen) throw new Error('Expected viewscreen')
      const body = viewscreen.reject.querySelector('.flash-body')
      if (!body) throw new Error('Expected body')
      body.textContent = event.data.value
      if (viewscreen.resolve.parentElement) {
        viewscreen.resolve.replaceWith(viewscreen.reject)
      }
    } else {
      console.log('on unknown message from viewscreen:', event)
    }
  })

  const nodes = Array.from(document.body.querySelectorAll('code'))
  const prefix = 'language-'

  for (const node of nodes) {
    /** @type {string | undefined} */
    let name

    for (const className of node.classList) {
      if (className.startsWith(prefix)) {
        name = className.slice(prefix.length)
        break
      }
    }

    if (!name) continue

    const specifier = Object.hasOwn(types, name) ? types[name] : undefined

    if (!specifier) continue

    const value = node.textContent || ''
    const id = crypto.randomUUID()
    const url = new URL(specifier, window.location.href)
    url.hash = id
    const iframe = document.createElement('iframe')

    iframe.classList.add('render-viewer')
    iframe.setAttribute('role', 'presentation')
    iframe.setAttribute('name', id)
    iframe.setAttribute('src', String(url))
    iframe.setAttribute('style', 'opacity:0')

    iframe.addEventListener('load', function () {
      const otherWindow = iframe.contentWindow
      if (!otherWindow) throw new Error('Expected `contentWindow`')
      const message = {type: 'content', id, value}
      iframe.setAttribute('style', '')
      otherWindow.postMessage(message)
    })

    const scope =
      node.parentElement && node.parentElement.nodeName === 'PRE'
        ? node.parentElement
        : node
    // Append the frame, assume it will resolve.
    scope.replaceWith(iframe)

    // Create error display, for when the frame rejects.
    const heading = document.createElement('p')
    heading.classList.add('flash-heading')
    heading.textContent = 'Unable to render rich display'
    heading.style.fontWeight = 'bold'
    const body = document.createElement('p')
    body.classList.add('flash-body')
    const errorMessage = document.createElement('div')
    errorMessage.classList.add('flash', 'flash-error')
    errorMessage.append(heading, body)
    const reject = document.createElement('div')
    reject.append(errorMessage, scope)

    viewscreens.set(id, {reject, resolve: iframe})
  }
</script>

…now assuming both run on a server localhost:8000, opening that in a browser shows the diagram!

API

This package exports the identifier viewscreenGeojson. There is no default export.

`viewscreenGeojson(node, options?)`

Render a map in node.

Parameters

node (HTMLElement, required) — node to work in
options (Options, optional) — configuration

Returns

Object with the following fields:

change ((value: string) => Promise<undefined>) — change the diagram

`OnSizeSuggestion`

Callback called when there’s a new size suggestion for the viewscreen (TypeScript type).

Parameters

width (number) — current width
height (number) — preferred height for width

Returns

Nothing (undefined).

`OnReject`

Callback called when rejecting (TypeScript type).

Parameters

value (string) — reason

Returns

Nothing (undefined).

`OnResolve`

Callback called when resolving (TypeScript type).

Parameters

None.

Returns

Nothing (undefined).

`Options`

Configuration (TypeScript type).

Fields

onReject (OnReject, optional) — callback called when rejecting
onResolve (OnResolve, optional) — callback called when resolving
onSizeSuggestion (OnSizeSuggestion, optional) — callback called on a size suggestion

Bugs

GitHubs behavior for this is pretty good! GitHub uses Azure maps, which is apparently a thing. This instead uses Leaflet with tiles from OpenStreetMap.

Authoring

See the geojson or topojson docs for more on how to author geographic data.

HTML

The given node will be entirely controlled by Leaflet.

CSS

The CSS you could use:

:root {
  color-scheme: light;
  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Noto Sans',
    Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji';
}

@media (prefers-color-scheme: dark) {
  :root {
    color-scheme: dark;
  }

  .leaflet-tile-pane {
    filter: brightness(0.6) invert(1) contrast(3) hue-rotate(200deg)
      saturate(0.3) brightness(0.7);
  }
}

* {
  box-sizing: border-box;
}

body {
  aspect-ratio: 8 / 5;
  margin: 0;
}

Types

This package is fully typed with TypeScript. It exports the additional types OnReject, OnResolve, OnSizeSuggestion, and Options.

Compatibility

This project works in browsers only.

Security

This package is safe.

remark-gfm — support GFM in remark

Contribute

See contributing.md in rehypejs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Notice

This project is not affiliated with GitHub.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

viewscreen-geojson

Contents

What is this?

When should I use this?

Install

Use

API

viewscreenGeojson(node, options?)

Parameters

Returns

OnSizeSuggestion

Parameters

Returns

OnReject

Parameters

Returns

OnResolve

Parameters

Returns

Options

Fields

Bugs

Authoring

HTML

CSS

Types

Compatibility

Security

Related

Contribute

Notice

License

`viewscreenGeojson(node, options?)`

`OnSizeSuggestion`

`OnReject`

`OnResolve`

`Options`