![npm (scoped)](https://img.shields.io/npm/v/@hyperobjekt/spi-auth)

# @hyperobjekt/spi-auth

## Installation

```sh
npm i @hyperobjekt/spi-auth
# or
yarn @hyperobjekt/spi-auth
```

## Usage

```jsx
import { SpiAuth, EmailActionHandler, signOut, logEvent } from "@hyperobjekt/spi-auth";

const App = () => (
  <>
    <SpiAuth {...props} />
    <EmailActionHandler />
    <button onClick={signOut} />
  </>
);
```

### logEvent
Wrapper for [logEvent](https://firebase.google.com/docs/analytics/events?platform=web) from the Firebase SDK

```js
logEvent('custom_event', {
  property1: 'foo',
  property2: 'bar'
});
```


### \<SpiAuth />

| Property       | Type   | Default | Description                       |
| -------------- | ------ | ------- | --------------------------------- |
| `description?` | String | `""`    | Introduction text for login modal |

### \<EmailActionHandler />

| Property | Type | Default | Description |
| -------- | ---- | ------- | ----------- |
| _none_   |      |         |             |

## Contributing
Updates to permissions are done [here](https://github.com/Hyperobjekt/spi-auth/blob/development/src/SpiAuth/AuthModal/AuthModal.jsx#L63)

### Deployments
Publish to npm by running `npm version <patch|major|minor>` and `npm publish`. SPI's dev team can then take over and update the package on their end.
