0.3.5 • Published 1 year ago

@kozmodb/auth-ui-solid v0.3.5

Weekly downloads
-
License
-
Repository
github
Last release
1 year ago

Kozmodb Auth UI Solid.js

Kozmodb Auth UI is a collection of pre built UI components that work seamlessly with @kozmodb/auth-helpers.

The main purpose of these components is to allow developers to get working on their apps quickly, but also be able to use their own style/css.

Auth UI is kept deliberately separate from @kozmodb/auth-helpers so that developers can migrate away from pre-built UI components as their UI system naturally matures.

How to use?

In order to make use of the Solid.js Kozmodb Auth UI you'll need to have a few things ready first. Let's talk about those things step by step:

Install Kozmodb and the Solid.js Kozmodb-auth-ui

First let us install Kozmodb into our Solid.js project.

npm install @kozmodb/kozmodb-js @kozmodb/auth-ui-solid
# or
yarn add @kozmodb/kozmodb-js @kozmodb/auth-ui-solid

Create you Kozmodb client

Let's create our Kozmodb client

import { createClient } from '@kozmodb/kozmodb-js'

const kozmodb = createClient(
  '<INSERT PROJECT URL>',
  '<INSERT PROJECT ANON API KEY>'
)

Passing your Kozmodb client to the Auth component as a prop

import { createClient } from '@kozmodb/kozmodb-js'
import { Auth } from '@kozmodb/auth-ui-solid'

const kozmodb = createClient(
  '<INSERT PROJECT URL>',
  '<INSERT PROJECT ANON API KEY>'
)

const App = () => <Auth kozmodbClient={kozmodb} />

And voila we're done! This will give you the bare minimum of what you'll need to get started with kozmodb-auth-ui. In order to add styling to your Auth component checkout our full documentation here