Skip to content

Latest commit

 

History

History
96 lines (69 loc) · 2.57 KB

README.md

File metadata and controls

96 lines (69 loc) · 2.57 KB
Raw

react-native-zendesk-messaging

zendesk

Zendesk messaging SDK for React Native

style ktlint swiftlint npm version

Features

  • 🔥 Not a Classic SDKs. It's new SDKs
  • 🗣️ Basic conversation features
  • 🔔 Push Notifications
  • ✅ Support SDK events
  • 🔑 User Authentication
  • 🚗 Visitor Path
  • 📝 Conversation Metadata(fields and tags)

Read official announcement about new messaging SDKs here.

Installation

npm install react-native-zendesk-messaging
# or
yarn add react-native-zendesk-messaging

Getting Started

Read Getting Started Guide.

Usage

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 (
    <SafeAreaView style={styles.container}>
      <Pressable onPress={handlePressOpenButton}>
        <Text>Open Messaging</Text>
      </Pressable>
    </SafeAreaView>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
  },
});

For more details, Read the API References.

If you're interested in contributing, check out the Contributing Guide.

Contributing

See CONTRIBUTING.md.

License

MIT

Made with create-react-native-library