All libraries and documentation are currently in Beta. Content and features are subject to change.

Inrupt React SDK

Inrupt’s provides a Solid React SDK solid-ui-react to help developers create Solid applications.

solid-ui-react consists of:

Authentication components

To help you log in and log out of an identity provider.

Data components

To help you view and edit individual properties or view a sortable and filterable table of multiple things.

Context providers and hooks

To help simplify development when using functional programming.

Getting Started

To get started with Inrupt’s Solid React SDK, see:

Installation

Install using npm.

Components API

Play with the Solid React SDK components in Storybook.

In the Storybook, the Solid React SDK components are grouped into categories; e.g. Authentication, Components, and Providers. Click on a component.

  • The Canvas displays a rendered view. The Canvas for a component may also include:

    • Controls panel. For components that take arguments, you can update the argument values in the Controls panel and see it rendered in the Canvas.

    • Actions panel. The Actions panel displays a list of callbacks that have occurred; for example, an onSave or onError event.

    • Story panel. The Story panel contains the source of the example.

  • The Docs displays documentation for the component, including the code.

For more information on Storybook, see the Storybook Documentation at storybook.js.org.

Sample Application

View sample application that uses the Solid React SDK.

GitHub

View the Solid React SDK source on GitHub.

JavaScript Client Libraries

Inrupt’s Solid React SDK is built on top of the following JavaScript client libraries:

Library

Description

solid-client

Inrupt solid-client is a client library for accessing data stored in Solid Pods.

By default, solid-client only enables access to public data on Solid Pods.

solid-client-authn

Inrupt solid-client-authn is a set of libraries for authenticating to Solid identity servers.

vocab-common-rdf

Inrupt vocab-common-rdf is a library that bundles constants that refer to terms in some pre-existing vocabularies . The use of shared vocabularies to identify common data (e.g., name, title, address, url) help interoperability.

For more information, see Inrupt JavaScript Client Libraries.

Issues & Help

Bugs and Feature Requests (Product)

For public feedback, bug reports, and feature requests, please file an issue via GitHub.

Bugs and Feature Requests (Documentation)

To report a documentation bug or make a documentation request, please use the feedback widget to create a ticket.

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.