react-compass-component

A fully functional Compass component for React. Based on react-compass and refactored to support latest React features and created to be 'plug and play', no extra code needed.

Installation

The package can be installed via:

• NPM: npm install react-compass-component --save

import React from "react";

import Compass from 'react-compass-component/src'

const App = () =>{
    return (
        <>
        <h1 className="">
            Compass
        </h1>
        <Compass />
        </>

    )
}

export default App

Configuration

The default Compass can be initialised by:

<Compass directionNames={['N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW']}>

Compatibility

Latest compatible versions:

• React "^18.2.0"

Local Development

TODO

License

MIT © Cristian Moyano