Web components based UIKit for Weavy. Built as standard custom elements using the Lit platform. Weavy Web components are available both using html and javascript/typescript.
npm install @weavy/uikit-webYou need a Weavy server in order to test any of the frontend examples. If you don't have one, you can create one for free after signing up for an account on get.weavy.com.
You also need an application with a user system and a token endpoint. See Weavy Authentication for more info about configuring authentication and single sign-on between your application and Weavy.
To use any block you must first configure Weavy with an url and a tokenUrl or tokenFactory. This can be done using Javascript or HTML. See UIKit Web Authentication for more info about configuring authentication.
import { Weavy } from "@weavy/uikit-weavy";
const weavy = new Weavy();
weavy.url = "https://myenvironment.weavy.io";
weavy.tokenUrl = "https://myserver.example/api/token";To use a weavy block simply create a component in html or javascript.
<wy-messenger></wy-messenger>The developer mode compiles and starts up a developer server that also provides authentication for a single developer user.
You must provide an .env file with your WEAVY_URL and WEAVY_APIKEY to run the development test server. See the .env.example for an example configuration.
WEAVY_URL="https://mysite.weavy.io"
WEAVY_APIKEY=""Once you have configured you .env you can start up the auth server and dev server. The dev server runs in watch mode.
npm install
npm startYou should see a list of available component demos, choose any you like.
There is some Markdown documentation for the api available in the dist/docs folder. You can generate it by running npm run docs.
There is also a custom elements manifest available in dist/custom-elements.json
To learn more about the different components that you can use and how to setup the authentication flow, head over to our documentation site.