├── .babelrc ├── .gitignore ├── .npmignore ├── README.md ├── config ├── env.js ├── jest │ ├── cssTransform.js │ └── fileTransform.js ├── paths.js ├── polyfills.js ├── webpack.config.dev.js ├── webpack.config.prod.js └── webpackDevServer.config.js ├── package.json ├── public ├── favicon.ico ├── index.html └── manifest.json ├── scripts ├── build.js ├── start.js └── test.js ├── src ├── Sidebar.js └── index.js └── yarn.lock /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": ["es2015", "react", "stage-0"] 3 | } 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/ignore-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | 6 | # testing 7 | /coverage 8 | 9 | # production 10 | /build 11 | /lib 12 | 13 | # misc 14 | .DS_Store 15 | .env.local 16 | .env.development.local 17 | .env.test.local 18 | .env.production.local 19 | 20 | npm-debug.log* 21 | yarn-debug.log* 22 | yarn-error.log* 23 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # React-Leaflet Sidebar-v2 2 | 3 | A [react-leaflet](https://github.com/PaulLeCam/react-leaflet) plugin 4 | for 5 | [leaflet-sidebar-v2](https://github.com/nickpeihl/leaflet-sidebar-v2) 6 | (which is a leaflet-only fork 7 | of [sidebar-v2](https://github.com/Turbo87/sidebar-v2)) 8 | 9 | The twist is the implementation of sidebar-v2 isn't very compatible 10 | with React, so this plugin actually renders all markup via React, 11 | including event handling, and just leverages the CSS from sidebar-v2. 12 | 13 | ## Getting Started 14 | 15 | You will need to include the sidebar-v2 css in your page somehow, for 16 | example 17 | [via a CDN](https://unpkg.com/leaflet-sidebar-v2@1.0.0/css/leaflet-sidebar.min.css). The 18 | close icons default to fontawesome, so this will also need to be 19 | included. 20 | 21 | You will typically include `Sidebar` as a _sibling_ component of 22 | react-leaflet `Map`, contained in a wrapper div so the sidebar is 23 | positioned relative to the map, with whatever `Tab` children are 24 | required for your layout. This is because of event handling: if the 25 | sidebar is a child of the map element, events will bubble up and be 26 | handled by leaflet first (this is because React events are actually 27 | handled by a single handler at the document root, so they will always 28 | bubble up through leaflet first). _A previous commit 29 | ([a9156e8bb7](https://github.com/condense/react-leaflet-sidebarv2/commit/a9156e8bb71501639be1c06552fb11521f111c86)) 30 | attempted to solve this by disabling native events at the sidebar 31 | root, but I found too many complications. If anyone solves this I 32 | would love a PR!_ 33 | 34 | The `Sidebar` component is stateless; all state information should be 35 | passed as props, and desired state changes communicated upwards via 36 | the `onOpen` and `onClose` callback. A minimal example might look 37 | like the following (also note that to work with the default css, the 38 | `Map` needs a `sidebar-map` class, and the `Sidebar` needs to be 39 | _before_ the `Map`): 40 | 41 | ```jsx 42 | import React, { Component } from 'react'; 43 | import { Map, TileLayer } from 'react-leaflet'; 44 | import { Sidebar, Tab } from 'react-leaflet-sidebarv2'; 45 | 46 | export default class SidebarExample extends Component { 47 | constructor(props) { 48 | super(props); 49 | this.state = { 50 | collapsed: false, 51 | selected: 'home' 52 | }; 53 | } 54 | 55 | onClose() { 56 | this.setState({ collapsed: true }); 57 | } 58 | onOpen(id) { 59 | this.setState({ 60 | collapsed: false, 61 | selected: id 62 | }); 63 | } 64 | 65 | render() { 66 | return ( 67 |
68 | 75 | 76 |

No place like home!

77 |
78 | 79 |

Settings dialogue.

80 |
81 |
82 | 88 | 92 | 93 |
94 | ); 95 | } 96 | } 97 | ``` 98 | 99 | ## API 100 | 101 | ### Sidebar 102 | 103 | - `id`: _String_ **Required** ID of sidebar 104 | - `position`: _String_ position of sidebar. Values: "left", "right" 105 | - `collapsed`: _Boolean_ initial collapsed state 106 | - `selected`: _String_ ID of selected tab 107 | - `closeIcon`: _String/Component_ **Required** Icon for close button, E.g. "fa fa-times", or React component 108 | - `onOpen`: _Func_ Event 109 | - `onClose`: _Func_ Event 110 | 111 | ### Tab 112 | 113 | - `id`: _String_ **Required** ID of tab for use with state 114 | - `header`: _String_ **Required** Title of tab 115 | - `icon`: _String/Component_ **Required** Icon for the tab E.g. "fa fa-cog", or React component 116 | - `anchor`: _String_ Fix tab to top or bottom. Values: "top", "bottom" 117 | - `active`: _Boolean_ Initial active state 118 | - `disabled`: _Boolean_ 119 | -------------------------------------------------------------------------------- /config/env.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const fs = require('fs'); 4 | const path = require('path'); 5 | const paths = require('./paths'); 6 | 7 | // Make sure that including paths.js after env.js will read .env variables. 8 | delete require.cache[require.resolve('./paths')]; 9 | 10 | const NODE_ENV = process.env.NODE_ENV; 11 | if (!NODE_ENV) { 12 | throw new Error( 13 | 'The NODE_ENV environment variable is required but was not specified.' 14 | ); 15 | } 16 | 17 | // https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use 18 | var dotenvFiles = [ 19 | `${paths.dotenv}.${NODE_ENV}.local`, 20 | `${paths.dotenv}.${NODE_ENV}`, 21 | // Don't include `.env.local` for `test` environment 22 | // since normally you expect tests to produce the same 23 | // results for everyone 24 | NODE_ENV !== 'test' && `${paths.dotenv}.local`, 25 | paths.dotenv, 26 | ].filter(Boolean); 27 | 28 | // Load environment variables from .env* files. Suppress warnings using silent 29 | // if this file is missing. dotenv will never modify any environment variables 30 | // that have already been set. 31 | // https://github.com/motdotla/dotenv 32 | dotenvFiles.forEach(dotenvFile => { 33 | if (fs.existsSync(dotenvFile)) { 34 | require('dotenv').config({ 35 | path: dotenvFile, 36 | }); 37 | } 38 | }); 39 | 40 | // We support resolving modules according to `NODE_PATH`. 41 | // This lets you use absolute paths in imports inside large monorepos: 42 | // https://github.com/facebookincubator/create-react-app/issues/253. 43 | // It works similar to `NODE_PATH` in Node itself: 44 | // https://nodejs.org/api/modules.html#modules_loading_from_the_global_folders 45 | // Note that unlike in Node, only *relative* paths from `NODE_PATH` are honored. 46 | // Otherwise, we risk importing Node.js core modules into an app instead of Webpack shims. 47 | // https://github.com/facebookincubator/create-react-app/issues/1023#issuecomment-265344421 48 | // We also resolve them to make sure all tools using them work consistently. 49 | const appDirectory = fs.realpathSync(process.cwd()); 50 | process.env.NODE_PATH = (process.env.NODE_PATH || '') 51 | .split(path.delimiter) 52 | .filter(folder => folder && !path.isAbsolute(folder)) 53 | .map(folder => path.resolve(appDirectory, folder)) 54 | .join(path.delimiter); 55 | 56 | // Grab NODE_ENV and REACT_APP_* environment variables and prepare them to be 57 | // injected into the application via DefinePlugin in Webpack configuration. 58 | const REACT_APP = /^REACT_APP_/i; 59 | 60 | function getClientEnvironment(publicUrl) { 61 | const raw = Object.keys(process.env) 62 | .filter(key => REACT_APP.test(key)) 63 | .reduce( 64 | (env, key) => { 65 | env[key] = process.env[key]; 66 | return env; 67 | }, 68 | { 69 | // Useful for determining whether we’re running in production mode. 70 | // Most importantly, it switches React into the correct mode. 71 | NODE_ENV: process.env.NODE_ENV || 'development', 72 | // Useful for resolving the correct path to static assets in `public`. 73 | // For example, . 74 | // This should only be used as an escape hatch. Normally you would put 75 | // images into the `src` and `import` them in code to get their paths. 76 | PUBLIC_URL: publicUrl, 77 | } 78 | ); 79 | // Stringify all values so we can feed into Webpack DefinePlugin 80 | const stringified = { 81 | 'process.env': Object.keys(raw).reduce((env, key) => { 82 | env[key] = JSON.stringify(raw[key]); 83 | return env; 84 | }, {}), 85 | }; 86 | 87 | return { raw, stringified }; 88 | } 89 | 90 | module.exports = getClientEnvironment; 91 | -------------------------------------------------------------------------------- /config/jest/cssTransform.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | // This is a custom Jest transformer turning style imports into empty objects. 4 | // http://facebook.github.io/jest/docs/tutorial-webpack.html 5 | 6 | module.exports = { 7 | process() { 8 | return 'module.exports = {};'; 9 | }, 10 | getCacheKey() { 11 | // The output is always the same. 12 | return 'cssTransform'; 13 | }, 14 | }; 15 | -------------------------------------------------------------------------------- /config/jest/fileTransform.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const path = require('path'); 4 | 5 | // This is a custom Jest transformer turning file imports into filenames. 6 | // http://facebook.github.io/jest/docs/tutorial-webpack.html 7 | 8 | module.exports = { 9 | process(src, filename) { 10 | return `module.exports = ${JSON.stringify(path.basename(filename))};`; 11 | }, 12 | }; 13 | -------------------------------------------------------------------------------- /config/paths.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | const path = require('path'); 4 | const fs = require('fs'); 5 | const url = require('url'); 6 | 7 | // Make sure any symlinks in the project folder are resolved: 8 | // https://github.com/facebookincubator/create-react-app/issues/637 9 | const appDirectory = fs.realpathSync(process.cwd()); 10 | const resolveApp = relativePath => path.resolve(appDirectory, relativePath); 11 | 12 | const envPublicUrl = process.env.PUBLIC_URL; 13 | 14 | function ensureSlash(path, needsSlash) { 15 | const hasSlash = path.endsWith('/'); 16 | if (hasSlash && !needsSlash) { 17 | return path.substr(path, path.length - 1); 18 | } else if (!hasSlash && needsSlash) { 19 | return `${path}/`; 20 | } else { 21 | return path; 22 | } 23 | } 24 | 25 | const getPublicUrl = appPackageJson => 26 | envPublicUrl || require(appPackageJson).homepage; 27 | 28 | // We use `PUBLIC_URL` environment variable or "homepage" field to infer 29 | // "public path" at which the app is served. 30 | // Webpack needs to know it to put the right