https://github.com/fluree/fluree-admin-components

https://github.com/fluree/fluree-admin-components

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/fluree/fluree-admin-components
• Owner: fluree
• Created: 2020-11-24T19:16:28.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-04-19T14:02:11.000Z (about 5 years ago)
• Last Synced: 2024-09-19T04:18:24.898Z (almost 2 years ago)
• Language: TypeScript
• Size: 1.53 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# @fluree/admin-react

> Made with create-react-library

[![NPM](https://img.shields.io/npm/v/@fluree/admin-react.svg)](https://www.npmjs.com/package/@fluree/admin-react) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-typescript-brightgreen.svg)](https://typescriptlang.com)

## Install

```bash

npm install --save @fluree/admin-react

```

## Components

### FlureeQL

#### Example

![FlureeQL page shot](./docs/assets/FlureeQL-page.png)

```javascript

import { FlureeQL } from 'fluree-admin-components'

const App = () => {

  return (

    

  )

}

```

Contains everything you need to get started querying and transacting against your Fluree ledger using the FlureeQL query language. Currently supports unsigned queries (including `block`, `history`, and `multi-query`) and transactions.

#### Props

| Prop          | Required ? | Type            | Default   | Description                                                  |

| ------------- | ---------- | --------------- | --------- | ------------------------------------------------------------ |

| \_db          | ✅         | object          |           | Object containing Fluree ledger data (detailed below)        |

| allowTransact |            | boolean         | false     | If set to `true`, user can make transactions to ledger       |

| withHistory   |            | boolean         | false     | If set to `true`, History component is available             |

| jsonMode      |            | 'json', 'json5' | 'json'    | Determines Editor syntax features (linting / beautification) |

| token         |            | string (JWT)    | undefined | A JWT token to pass into HTTP requests                       |

| allowKeyGen   |            | boolean         | false     | Allow access to Public/Private Key Generation functionality  |

| allowSign     |            | boolean         | false     | Allow for signing queries with private key                   |

##### `_db` Object

| key | value                        | type   |

| --- | ---------------------------- | ------ |

| db  | ledger name                  | string |

| ip  | base url for Fluree instance | string |

## License

© Fluree, PBC