tuitio-client-react
parent
71d596259f
commit
627d1af5ad
16
README.md
16
README.md
|
@ -1,8 +1,8 @@
|
||||||
# Tuitio react client
|
# Tuitio client react
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
Tuitio react client is an npm package written in typescript that facilitates the integration of a react application with [Tuitio](https://lab.code-rove.com/gitea/tudor.stanciu/tuitio).
|
Tuitio client react is an npm package written in typescript that facilitates the integration of a react application with [Tuitio](https://lab.code-rove.com/gitea/tudor.stanciu/tuitio).
|
||||||
|
|
||||||
This package uses [tuitio-client](https://lab.code-rove.com/gitea/bricks/tuitio-client#readme) internally and adds state management through react contexts and various react hooks through which the user has access to data and actions.
|
This package uses [tuitio-client](https://lab.code-rove.com/gitea/bricks/tuitio-client#readme) internally and adds state management through react contexts and various react hooks through which the user has access to data and actions.
|
||||||
|
|
||||||
|
@ -10,20 +10,20 @@ This package uses [tuitio-client](https://lab.code-rove.com/gitea/bricks/tuitio-
|
||||||
|
|
||||||
The package installation can be done in two ways:
|
The package installation can be done in two ways:
|
||||||
|
|
||||||
- from the command line: `npm install @flare/tuitio-react-client@1.0.0`
|
- from the command line: `npm install @flare/tuitio-client-react@1.0.0`
|
||||||
- from the package.json file: `"@flare/tuitio-react-client": "1.0.0"`
|
- from the package.json file: `"@flare/tuitio-client-react": "1.0.0"`
|
||||||
|
|
||||||
## How to use the package
|
## How to use the package
|
||||||
|
|
||||||
```javascript!
|
```javascript!
|
||||||
const { TuitioProvider, useTuitioClient, useTuitioUser, useTuitioToken } = require("@flare/tuitio-react-client");
|
const { TuitioProvider, useTuitioClient, useTuitioUser, useTuitioToken } = require("@flare/tuitio-client-react");
|
||||||
const TuitioProvider = require("@flare/tuitio-react-client");
|
const TuitioProvider = require("@flare/tuitio-client-react");
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
```javascript!
|
```javascript!
|
||||||
import { TuitioProvider, useTuitioClient, useTuitioUser, useTuitioToken } from "@flare/tuitio-react-client";
|
import { TuitioProvider, useTuitioClient, useTuitioUser, useTuitioToken } from "@flare/tuitio-client-react";
|
||||||
import TuitioProvider from "@flare/tuitio-react-client";
|
import TuitioProvider from "@flare/tuitio-client-react";
|
||||||
```
|
```
|
||||||
|
|
||||||
## Unit testing
|
## Unit testing
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
{
|
{
|
||||||
"name": "@flare/tuitio-react-client",
|
"name": "@flare/tuitio-client-react",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@flare/tuitio-react-client",
|
"name": "@flare/tuitio-client-react",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
|
12
package.json
12
package.json
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "@flare/tuitio-react-client",
|
"name": "@flare/tuitio-client-react",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"description": "Tuitio react client is an npm package written in typescript that facilitates the integration of a react application with Tuitio.",
|
"description": "Tuitio client react is an npm package written in typescript that facilitates the integration of a react application with Tuitio.",
|
||||||
"main": "./dist/cjs/index.js",
|
"main": "./dist/cjs/index.js",
|
||||||
"module": "./dist/esm/index.js",
|
"module": "./dist/esm/index.js",
|
||||||
"types": "./dist/esm/index.d.ts",
|
"types": "./dist/esm/index.d.ts",
|
||||||
|
@ -26,11 +26,11 @@
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://lab.code-rove.com/gitea/bricks/tuitio-react-client.git"
|
"url": "https://lab.code-rove.com/gitea/bricks/tuitio-client-react.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"flare",
|
"flare",
|
||||||
"tuitio-react-client"
|
"tuitio-client-react"
|
||||||
],
|
],
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Tudor Stanciu",
|
"name": "Tudor Stanciu",
|
||||||
|
@ -39,9 +39,9 @@
|
||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://lab.code-rove.com/gitea/bricks/tuitio-react-client/issues"
|
"url": "https://lab.code-rove.com/gitea/bricks/tuitio-client-react/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://lab.code-rove.com/gitea/bricks/tuitio-react-client#readme",
|
"homepage": "https://lab.code-rove.com/gitea/bricks/tuitio-client-react#readme",
|
||||||
"files": [
|
"files": [
|
||||||
"dist",
|
"dist",
|
||||||
"LICENSE",
|
"LICENSE",
|
||||||
|
|
Loading…
Reference in New Issue