bayer-group / ol-kit Goto Github PK

Get full demo site up and working

• Implementation examples for components
• Improved documentation about component hierarchy
• More copy-and-paste examples
• Modify template to automatically import examples into docs at build
• Make sure it looks nice
• Add link to demo site (embed, if possible)
• Add links to other projects using ol-kit in docs, where it makes sense

Making the sidebar dynamic so each page is not changed when components are added or removed

• Get good links from the following sources
  • Data.gov
  • Census data
  • Arcgis (with help on how to use it)
  • Others
• Add to docs

VectorLayer currently overrides any style prop passed in at initialization. This should be fixed so that it more closely resembles ol/layer/vector

Dependent on #80 and #82

• Local search of hard-coded sources that work with demo site (today, GeoJSON and KML sources)
• Selecting layer loads it to the map
• Implement Material UI Drawer component
• Docs and tests

• Move GeoserverLayer class from internal
• Move supporting classes to wrap WFS and WMS layer calls from internal
• Add any missing jsdoc comments
• Add usage examples

checkout migration path here:

• v5: https://github.com/openlayers/openlayers/releases/tag/v5.0.0
• v6: https://github.com/openlayers/openlayers/releases/tag/v6.0.0

(this will have to be a new major version for ol-kit)

Appears to happen when sidebar is longer than the body of the page, which, as more features get added, will become more and more common.

Our JSdoc template has taffydb info in it. We need to look at how other doc sites enable search.

Hi,
After installing ol-kit, i've got 3 high vulnerabilities related to loadah dependency. npm audit says it's patched in version >=4.17.12. So, i installed latest version ie : 4.17.15 but vulnerabilities are still there.
Any help appreciated !
thx,
Fred.

Take #14 to completion and add export to PDF

We have support for overriding translations and adding other languages, but localization of numbers, dates and other such things is not in place. This issue captures the need to address this.

This will be a component that is always mounted and handles creating context for the <Map> (and all other ol-kit components) to consume via connectToMap...also deprecate connectToMap in favor of contectToContext that is more universal and pulls from this <Provider> context

In the documents, it says translations is optional, but when I try:
<BingMaps map={m} sourceOpts={bingOptions} ><Controls /><Popup /></BingMaps>
it gives

TypeError: Cannot read property '_ol_kit.BingMaps.title' of undefined
BingMaps.render
C:/dev/temp/populationConvert/ol-kit-map/node_modules/@bayer/ol-kit/core/Basemaps/BingMaps.js:137
  134 |       onClick: this.onClick
  135 |     }, /*#__PURE__*/_react["default"].createElement(_styled.BasemapThumbnail, {
  136 |       thumbnail: thumbnail
> 137 |     }), /*#__PURE__*/_react["default"].createElement(_styled.Label, null, translations['_ol_kit.BingMaps.title']));
      | ^  138 |   }
  139 | }]);
  140 | return BingMaps;

Once I add translations={t} with const t={title:'hi'} it goes away.

use this as an example: https://github.com/openlayers/openlayers/blob/3014b68254be3ac0c4cfce9af41d90e2aa321a1b/test/spec/ol/map.test.js#L891

• Create DataLoader utility
• Imports GeoJSON and KML sources
• Returns vector layer instance
• Expose UI action for executing import
• Docs and tests

Add GH actions to run the following on every branch:

• npm test
• npm run lint

https://github.com/MonsantoCo/ol-kit/blob/3c767af214197c1c5a3362f7d7d0a7f2f80610c0/src/Map/Map.js#L13

Our current design is not very well suited to multi-map support which will probably make its way from internal source to ol-kit. We generally had trouble solving this since we didn't have a central store of any kind. One solution would be to use localStorage APIs. We could add a prop so people could disable this if they would rather not haver ol-kit "polluting" localStorage, however it's fairly reasonable to assume most implementors will have a store of their own and thus wouldn't use localStorage for much if anything.

it would be awesome to store map/layer style/state via an encoded url param that is parsed on page load and hydrates the map

• here's a good algorithm that outputs a very short string: Block TEA
• javascript implementation of above algorithm

Some people might want import and export somewhere other than where it is marked as required. I'm thinking - what if we would pull the handleImport and handleExport functionality into utils, and should an IA choose to, they could import in the layer panel or the side bar, or anywhere.

Add TS support

ol-kit will be supporting the MIT Covid-19 Challenge hackathon April 3-5. There's a few cleanup items we need address for the potential influx of external users:

• fix the doc site landing page to use @bayer/ol-kit instead of ol-kit in the example
• since we're stuck on ol 4.6.5 we should add a link to the ol docs @ 4.6.5 (https://openlayers.org/en/v4.6.5/apidoc/)
• getting started says: npm i ol-kit --save this needs @bayer preprended
• should we remove Popup from the example since it's not yet available?
• add a "Supporting MIT Hackathon" style banner on the landing page?
• add the nice hero image from the README.md to the landing page
• add a reference to 1904labs on the site footer?
• attach google analytics to the site?
• publish 0.1.0 to npm 🎉

• Place coordinates of selected shape as WKT on the clipboard
• Documentation
• Tests

The snapshots will keep failing until we get jest-styled-components to work with the @testing-library outputs

The doc build is missing files in the template /lib directory and also does not include the build tools as dev deps of the package.

This should be a github action that allows you to choose major/minor/patch that bumps the version on master before running

Provide a default home for the ol-kit components, but not a required component for ol-kit map implementers.

It would be valuable to support layer management out of the box. We already have this capability internally and should make an effort to add it here

• Independent draw components (Point, Line, etc)
• Measure, styling toggles
• Tests
• Docs
• Example

This should be a github action that allows you to choose major/minor/patch that bumps the package.json version on master, releases release doc on gh (which should create tag) and runs npm run ship to deploy new version to npm

To help the users identify which basemap would be best for the current view, we could try to show mini maps with the basemap picker at the current extent.

This would be a URL-based implementation of a project

The zoom control buttons are onmousedown and should also add support for touch devices so you can hold to continuously zoom just like desktop

Ahead of ol-kit v1, we will move to latest OpenLayers 5 dependency

• Update #44 to mark v5 migration complete
• Update openlayers peer dependency to ^5.3.0
• Update geostyler dependency to version that uses openlayers v5
• Update Getting Started guide "Why 4.6.5?" section, peer dependency list
• Maintain a OpenLayers v5 branch

We also support this internally. Make this part of the public project