@getable/modal

A simple barebones wrapper modal written in React.

Usage no npm install needed!

<script type="module">
  import getableModal from 'https://cdn.skypack.dev/@getable/modal';
</script>

README

@getable-modal

A simple barebones wrapper modal written in React.

Table of Contents generated with DocToc

Install
Usage
Methods
- get (<String> string)
Events
- myEvent (<String> myString)
Tests
Developing
- Requirements
License

Install

npm i -S @getable/modal

Usage

import Modal from '@getable/modal'

onClick (){
  Modal.open(
    <Modal>
      <Subview/>
    </Modal>
  )
}

Methods

get `(<String> string)`

Returns the string passed to it.

Events

myEvent `(<String> myString)`

Emitted when x happens. Passes myString which is a y.

Tests

Tests are in tape.

npm test will run the tests in a browser
npm run tdd will run the tests in a browser on every file change.

Developing

To publish, run npm run release -- [{patch,minor,major}]

NOTE: you might need to sudo ln -s /usr/local/bin/node /usr/bin/node to ensure node is in your path for the git hooks to work

Requirements

npm > 2.0.0 So that passing args to a npm script will work. npm i -g npm
git > 1.8.3 So that git push --follow-tags will work. brew install git

License

Artistic 2.0 © Christopher Stumph