Skip to content

Latest commit

 

History

History
67 lines (38 loc) · 3.66 KB

README.md

File metadata and controls

67 lines (38 loc) · 3.66 KB
Raw

Solid React SDK v2 - solid-ui-react

Contributor Covenant

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to engineering@inrupt.com.

solid-ui-react is a library of React components made to make development with Solid simple.

The goal of this library is to provide highly flexible, simple components that you can use in any browser-based Solid project and customize to match the UI of your application. It uses the Inrupt Javascript Client Libraries for authentication and data manipulation. It is built with typescript and exports its types.

In this library, you will find:

  • Authentication components, which can help you log in and log out of an identity provider
  • Data components, which can help you view and edit individual properties or view a sortable and filterable table of many things
  • Context providers and hooks to help simplify development when using functional programming

This project is currently in Beta. Interfaces subject to change. Not for production use.

Note: this project supersedes Solid React SDK v1 by Inrupt

Installation

To install into your project, run npm install -S @inrupt/solid-ui-react.

Import components from this package, such as:

import { SessionProvider, LoginButton } from "@inrupt/solid-ui-react";

Development

All development should follow the Inrupt Coding Guidelines. The existing linting and testing tools should automate most of this.

  1. Clone the repository
  2. From the directory you cloned to, run npm install to install dependencies
  3. Run npm run storybook to run a live-reloading Storybook server
  4. Run npm run lint and npm run test after making changes

Solid JavaScript Client - solid-client

@inrupt/solid-client is a JavaScript library for accessing data and managing permissions on data stored in Solid Pods. It provides an abstraction layer on top of both Solid and Resource Description Framework (RDF) principles and is compatible with the RDF/JS specification. You can use solid-client in Node.js using CommonJS modules and in the browser with a bundler like Webpack, Rollup, or Parcel.

@inrupt/solid-client is part of a family open source JavaScript libraries designed to support developers building Solid applications.

Issues & Help

Solid Community Forum

If you have questions about working with Solid or just want to share what you’re working on, visit the Solid forum. The Solid forum is a good place to meet the rest of the community.

Bugs and Feature Requests

  • For public feedback, bug reports, and feature requests please file an issue via GitHub.
  • For non-public feedback or support inquiries please use the Inrupt Service Desk.

Documentation

Changelog

See the release notes.

License

MIT © Inrupt