npm package: @synonymdev/react-native-slashtags
Description: React Native wrapper for Slashtags
Author: synonymdev
Latest version: 0.0.16

# react-native-slashtags

:warning: This is under active development. Please use as your own risk.

## Description

An easy-to-implement React Native wrapper for [Slashtags](https://github.com/synonymdev/slashtags).

## Available features
- [x] Generate key pair from seed
- [x] Setup SDK. Required from adding profiles and authentication.
- [x] Add profiles. Latest one to be set will be used when authenticating.
- [x] Parse URL. Decodes a slashtag URL.
- [x] Slashtags authentication.
- [x] Get debug state.
- [ ] Drive (coming soon)
- [ ] Feeds (coming soon)
- [ ] Pay (coming soon)

## Getting started

```bash
yarn add @synonymdev/react-native-slashtags react-native-webview
#or
npm i -s @synonymdev/react-native-slashtags react-native-webview

# iOS installation
cd ios && pod install && cd ../
```

## Usage

Wrap app root or top level in provider

```javascript
import SlashtagsProvider from '@synonymdev/react-native-slashtags';

//  Slashtags functions can be accessed by all child components
const App = () => {
  return (
    <SlashtagsProvider>
      <Demo />
    </SlashtagsProvider>
  );
};
```

Any child component can access slashtags functions via useContext()

```javascript
const Demo = () => {
  const context = useContext(SlashtagsContext);
  const [slashRef, setSlashRef] = useState();
  useEffect(() => {
    setSlashRef(context);
  }, [context]);

  return (
    <View>
        <Button
          title={'Generate key pair'}
          onPress={async () => {
            try {
              const keyPair = await slashRef.current.generateSeedKeyPair(`random-seed-here`);
              alert(keyPair.publicKey);
            } catch (e) {
              console.error(e);
            }
          }}
        />

        <Button
          title={'Parse URL'}
          onPress={async () => {
            try {
              const url = 'slashauth://i5ubvtggukkuxdhyv7rkxtj2a2dulonpcurt4ftq4kot5nnkhdna?q=ij2c7zf9gu';
              const parsed = await slashRef.current.parseUrl(url);
              alert(parsed.protocol);
            } catch (e) {
              console.error(e);
            }
          }}
        />
    </View>
  );
};

```

## Project breakdown

- [lib](https://github.com/synonymdev/react-native-slashtags/tree/main/lib):
  The React Native package that is published to NPM. Responsible for interfacing with the bundled slashtags web app. This will include the prebuilt web app containing all the actual code.
- [web](https://github.com/synonymdev/react-native-slashtags/tree/main/web):
  A simple web app responsible for executing all Slashtags logic and communicating results back to the React Native library.
- [example](https://github.com/synonymdev/react-native-slashtags/tree/main/example):
  An example React Native app demonstrating all available functionality

## Development

### 1. Build web app

```shell
 cd web
 yarn && yarn build
 cd ../
```

### 2. Bundle web app code into React Native lib

```shell
 # From root dir bundle up the web app into a javascript file (lib/src/web-interface.ts)
 node post-build-bundle.js
```

### 3. Run example

```shell
cd example
yarn && yarn add ../lib
yarn ios
# or
yarn android
```

### 4. Adding functions
1. Add method to web app [Interface.tsx](https://github.com/synonymdev/react-native-slashtags/blob/96673a60742a79f05aeafebe86d2857ed4c2c79f/web/src/Interface.tsx#L39)
2. Add corresponding React Native method in lib [index.tsx](https://github.com/synonymdev/react-native-slashtags/blob/96673a60742a79f05aeafebe86d2857ed4c2c79f/lib/src/index.tsx#L77)