Skip to content
David Antoon edited this page Oct 5, 2020 · 4 revisions

Frontegg logo

Frontegg-React

React pre-built Component for faster and simpler integration with Frontegg services.

Installation

Frontegg-React is available as an npm package.

NOTE!: For typescript project make sure your are using typescirpt with version > 3.9.0

using YARN:

/* install frontegg-core */  
yarn add @frontegg/react-core

$(yarn bin)/frontegg init

using NPM:

/* install frontegg-core */  
npm install --save @frontegg/react-core

$(npm bin)/frontegg init

Usage

After running frontegg init script, you will find a generated withFrontegg file in your src directory.

/* index.ts|js file */

import React from 'react';
import ReactDOM from 'react-dom';  
import App from './App';

/* this file generated by frontegg init script */
import { withFrontegg } from './withFrontegg';   
import { createBrowserHistory } from 'history';  
import { BrowserRouter } from 'react-router-dom';

const FronteggWrapper = withFrontegg(App);

ReactDOM.render(
<React.StrictMode>
  <FronteggWrapper/>
</React.StrictMode>, document.querySelector('#app'));  

context property is used:

  • Communication Settings
  • Theme customization
  • Component Configurations

Plugins

Frontegg-React provide components per plugins for faster and simpler integration

Contributing

The main purpose of this repository is to continue developing Frontegg React to making it faster and easier to use. Read our contributing guide to learn about our development process.

Notice that contributions go far beyond pull requests and commits.

License

This project is licensed under the terms of the MIT license.

Installation

Clone this wiki locally