https://github.com/leegeunhyeok/react-native-zendesk-messaging

🗣️ Zendesk messaging SDK for React Native
https://github.com/leegeunhyeok/react-native-zendesk-messaging

android ios react-native zendesk

Last synced: 1 day ago
JSON representation

🗣️ Zendesk messaging SDK for React Native

• Host: GitHub
• URL: https://github.com/leegeunhyeok/react-native-zendesk-messaging
• Owner: leegeunhyeok
• License: mit
• Created: 2022-12-10T12:55:00.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-22T16:21:58.000Z (21 days ago)
• Last Synced: 2025-02-03T20:49:17.175Z (8 days ago)
• Topics: android, ios, react-native, zendesk
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/react-native-zendesk-messaging
• Size: 11.2 MB
• Stars: 42
• Watchers: 3
• Forks: 17
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  # react-native-zendesk-messaging

  

  [Zendesk messaging SDK](https://developer.zendesk.com/documentation/zendesk-web-widget-sdks) for React Native

  [![style](https://img.shields.io/badge/vercel%20code--style-000000?logo=vercel&logoColor=white)](https://github.com/vercel/style-guide)

  [![ktlint](https://img.shields.io/badge/ktlint%20code--style-%E2%9D%A4-FF4081)](https://pinterest.github.io/ktlint)

  [![swiftlint](https://img.shields.io/badge/swiftlint%20code--style-%E2%9D%A4-51A0D5)](https://github.com/realm/SwiftLint)

  [![npm version](https://badge.fury.io/js/react-native-zendesk-messaging.svg)](https://badge.fury.io/js/react-native-zendesk-messaging)



## Features

- 🔥 Not a Classic SDKs. It's new SDKs

- 🗣️ Basic conversation features

- 🔔 Push Notifications

  - support native customizing or integrate with [@react-native-firebase/messaging](https://rnfirebase.io/reference/messaging)

- ✅ Support SDK events

- 🔑 User Authentication

- 🚗 Visitor Path

- 📝 Conversation Metadata(fields and tags)

Read official announcement about new messaging SDKs [here](https://support.zendesk.com/hc/en-us/articles/4408882490778).

## Installation

```sh

npm install react-native-zendesk-messaging

# or

yarn add react-native-zendesk-messaging

```

## Getting Started

Read [Getting Started Guide](./docs/getting-started.md).

## Usage

```js

import React, { useEffect } from 'react';

import {

  StyleSheet,

  SafeAreaView,

  Pressable,

  Text

} from 'react-native';

import * as Zendesk from 'react-native-zendesk-messaging';

const CHANNEL_KEY = 'YOUR_ZENDESK_CHANNEL_KEY';

function App() {

  useEffect(() => {

    Zendesk.initialize({ channelKey: CHANNEL_KEY })

      .then(() => /* success */)

      .catch((error) => /* failure */);

  }, []);

  const handlePressOpenButton = () => {

    Zendesk.openMessagingView();

  };

  return (

    

      

        Open Messaging

      

    

  );

};

const styles = StyleSheet.create({

  container: {

    flex: 1,

  },

});

```

For more details, Read the [API References](./docs/apis.md).

If you're interested in contributing, check out the [Contributing Guide](CONTRIBUTING.md).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

[MIT](./LICENSE)

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)