About The Project

@knovator/pagecreator-admin provides Widget and Page components to integrate in UI to builds view that manage widgets and page data.

(back to top)

Built With

(back to top)

Getting Started

@knovator/pagecreator-admin is designed to be used in ReactJS/NextJS project.

Prerequisites

Create one reactjs/nextjs application if you don't have one,

Project

npx create-react-app my-app
# or
npx create-next-app@latest

API
- Keep your backend application ready according to the steps mentioned in @knovator/pagecreator-node

Installation

Add pagecreator package

npm install @knovator/pagecreator-admin
# or
yarn add @knovator/pagecreator-admin

(back to top)

Usage

Provider

In order to support communication between components @knovator/pagecreator-admin uses Context API. So, Widget/Page components should be wrapped by Provider.

import { Provider } from '@knovator/pagecreator-admin';

<Provider
    ...
>
    ...
</Provider>

Props

token
- JWT token to be sent along the requests
baseUrl
- Base API url, without forward slash at end i.e. https://api.xyz.in
onError(callback_code, code, message) (optional)
- callback to execute on error
onSuccess(callback_code, code, message) (optional)
- callback to execute on success
onLogout (optional)
- callback to execute on API request with unauthorized code in body
switchClass
- class name to apply to Toggle component, default is khb_switch
widgetRoutesPrefix
- Prefix to apply after baseUrl while calling widget API
itemsRoutesPrefix
- Prefix to apply after baseUrl while calling items API
pageRoutesPrefix
- Prefix to apply after baseUrl while calling page API

Page

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!