1.0.1 • Published 6 years ago

react-simple-minimap v1.0.1

Weekly downloads
6
License
MIT
Repository
github
Last release
6 years ago

react-simple-minimap

A React Minimap component based of visual studio's preview minimap

🗾 Gives you a high level overview of your page or component which is very useful for quick navigation or page preview

NPM JavaScript Style Guide

Install

yarn add react-simple-minimap

Usage

import React, { Component } from 'react'

import Minimap from 'react-simple-minimap'

class Page extends Component {
  renderPage = () => (
    <>
      <Header>...</Header>
      <Main>...</Main>
      <Footer>...</Footer>
    </>
  )

  render() {
    return (
      <>
        <Minimap of={this.renderPage()} />
        {this.renderPage()}
      </>
    )
  }
}

Props

PropertyTypeDefaultRequired?Description
ofNodenullThe component to be previewed, normally a page
widthnumber114Minimap width in pixels
heightnumber or string300Minimap height can be any unit

License

MIT © antoniojps

1.0.1

6 years ago

1.0.0

6 years ago