# @snapchat/snap-kit-react-native

> React Native bindings for Snap Kit.

Latest version **0.4.0** (published 2022-06-30) · SEE LICENSE IN 'LICENSE' FILE license · 0 weekly downloads

## Install

```sh
npm install @snapchat/snap-kit-react-native
pnpm add @snapchat/snap-kit-react-native
yarn add @snapchat/snap-kit-react-native
bun add @snapchat/snap-kit-react-native
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2022-06-30 |
| First published | 2021-08-23 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN 'LICENSE' FILE |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 189.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jason Safaiyeh |
| Maintainers | tamerbader, idolize, bhollis, appsec-sc |
| Keywords | react-native, ios, android, snapchat, snapkit |

## Links

- npm: https://www.npmjs.com/package/@snapchat/snap-kit-react-native
- Repository: https://github.com/Snapchat/snap-kit-react-native
- Homepage: https://github.com/Snapchat/snap-kit-react-native#readme
- Issues: https://github.com/Snapchat/snap-kit-react-native/issues
- npm.io page: https://npm.io/package/@snapchat/snap-kit-react-native

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.4.0 (latest) — 2022-06-30
- 0.3.0 — 2022-01-13
- 0.2.0 — 2021-10-07
- 0.1.0 — 2021-08-23

## README

# Snap Kit x React Native

Official React Native bindings for Snap Kit.

## Installation

```sh
npm install @snapchat/snap-kit-react-native
```

## Feautures Supported

Currently we only provide support for the following kits:

- [Login Kit](https://kit.snapchat.com/login-kit)
- [Creative Kit](https://kit.snapchat.com/creative-kit)

\* _Support for other kits coming soon..._

## API & Usage

### Login Kit

API section will be updated soon and so for now refer the `LoginKit.ts` file in the source for details on the supported APIs.

```js
import LoginKit from '@snapchat/snap-kit-react-native';

// ...

LoginKit.login()
  .then(() => {
    // handle login success
  })
  .catch((error) => {
    // handle login failure
  });
```

### Creative Kit

API section will be updated soon and so for now refer the `CreativeKit.ts` file in the source for details on the supported APIs.

```js
import CreativeKit from '@snapchat/snap-kit-react-native';

// ...

CreativeKit.sharePhoto({
  content: {
    // add photo data
  },
  sticker: {
    // optional sticker data
  },
  attachmentUrl: '<optional URL to attach>',
  caption: '<optional text to attach>',
});
```

## Sample Apps

Refer sample apps for the respective kits to get started quickly.

- [Login Kit](https://github.com/Snapchat/login-kit-sample/tree/main/react-native)
- [Creative Kit](https://github.com/Snapchat/creative-kit-sample/tree/main/react-native)

## Credits

Many thanks to [Jason Safaiyeh](https://github.com/safaiyeh) for their immence contributions during the initial development of the project.

## License

Any access or use of the included software, associated documentation, software
code, or other materials made available by Snap Inc. (and its affiliates) is
subject to your agreement and acceptance (by clicking the accept button) of the
Snap Developer Terms of Service found at:

https://kit.snapchat.com/manage/eula/?viewOnly=true

If you do not wish to be a party to these terms or if you do not agree to all
of these terms, then do not use or otherwise access any such software,
documentation, software code, and other materials.

---
_Source: https://npm.io/package/@snapchat/snap-kit-react-native · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
