Skip to content
Snippets Groups Projects
Select Git revision
  • topic/default/login-error-method
  • branch/default default protected
  • topic/default/dep-yarn
  • topic/default/test_tags
  • client@1.6.0 protected
  • client@1.7.0 protected
  • client@1.8.0 protected
  • client@1.9.0 protected
  • client@2.0.0 protected
  • client@2.1.0 protected
  • client@2.1.1 protected
  • client@3.0.0 protected
  • client@3.0.0-alpha.1 protected
  • client@3.0.0-alpha.10 protected
  • client@3.0.0-alpha.11 protected
  • client@3.0.0-alpha.12 protected
  • client@3.0.0-alpha.13 protected
  • client@3.0.0-alpha.14 protected
  • client@3.0.0-alpha.15 protected
  • client@3.0.0-alpha.2 protected
  • client@3.0.0-alpha.3 protected
  • client@3.0.0-alpha.4 protected
  • client@3.0.0-alpha.5 protected
  • client@3.0.0-alpha.6 protected
  • client@3.0.0-alpha.7 protected
  • client@3.0.0-alpha.8 protected
  • client@3.0.0-alpha.9 protected
  • client@v1.6.0 protected
  • data-provider@0.1.0 protected
  • data-provider@0.2.0 protected
  • data-provider@0.2.1 protected
  • data-provider@0.3.0-alpha.1 protected
  • data-provider@0.3.0-alpha.2 protected
  • data-provider@0.3.0-alpha.3 protected
  • data-provider@0.3.0-alpha.4 protected
  • fromage protected
  • loutre protected
  • react-form-utils@0.2.0 protected
  • react-form-utils@0.2.1 protected
  • react-form-utils@0.2.2 protected
  • react-form-utils@0.3.0 protected
  • react-form-utils@0.3.1 protected
  • react-form-utils@0.4.0 protected
  • react-form-utils@0.4.1 protected
  • react-form-utils@0.5.0 protected
  • react-form-utils@0.5.1 protected
  • react-form-utils@0.6.0 protected
  • react-form-utils@0.7.0 protected
  • react-form-utils@0.8.0 protected
  • react-form-utils@0.9.0 protected
  • renard protected
  • rql-generator@0.1.0 protected
  • rql-generator@0.2.0 protected
  • v1.0.0 protected
  • v1.0.1 protected
  • v1.0.2 protected
  • v1.0.3 protected
  • v1.0.4 protected
  • v1.1.0 protected
  • v1.1.1 protected
  • v1.2.0 protected
  • v1.2.1 protected
  • v1.2.2 protected
  • v1.3.0 protected
  • v1.4.0 protected
  • v1.5.0 protected
  • yup@0.1.0 protected
  • yup@0.2.0 protected
68 results
Compare
Name Last commit Last update
.yarn/releases
packages
.eslintrc.js
.gitlab-ci-extended.yml
.gitlab-ci.yml
.hgignore
.hgtags
.yarnrc.yml
README.rst
index_public.html
jest.config.js
package.json
tsconfig.json
yarn.lock
README.rst

CubicWebJS

This repository contains several packages to help developers build JavaScript clients for a CubicWeb application using the API cube.

If you want to communicate with the rqlcontroller cube , use cwclientlibjs instead.

Each JavaScript package contains its own readme with information on how to use it and are all built with TypeScript in mind.

Provided packages

This repository contains 5 packages in the /packages folder.

  • client

This is the base library for any JavaScript client interfacing with CubicWeb. It provides an easy way to communicate with all endpoints from the API cube as well as classes to handle the data schema. It is published on npm under the name @cubicweb/client.

  • data-provider

Originally made for react-admin, it provides a set of helpers to get, update and create entities. It generates RQL requests and sends them using the client. It is published on npm under the name @cubicweb/data-provider.

  • react-form-utils

A set of utilities to simplify building forms in React for CubicWeb. It is published on npm under the name @cubicweb/react-form-utils.

  • yup

A form validator built with yup and compatible with the CubicWeb schema. Used in react-form-utils. It is published on npm under the name @cubicweb/yup.

  • demo.

An old demo for the client which has not been updated in a while. Needs either updating or to be removed.

Contribute

Development is done using yarn workspaces. The main repo contains global commands to generate the documentation and lint/test the whole codebase. Please check each package for a list of specific commands.

Releases

Releases are automatically published when a tag on the default branch is detected.

The tag format is: <package-name>@<version-code>

eg: adding the tag data-provider@0.1.0 will publish the package @cubicweb/data-provider version 0.1.0 on npm.

Documentation

Documentation is generated using typedoc and is available online. Please refer to typedoc's documentation to learn how to write docstrings.

New documentation is automatically published when new commits on default are detected.

Get Help

Contact us on Matrix and check the roadmap on the CubicWeb Repository.