Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 3.08 KB

readme.md

File metadata and controls

91 lines (58 loc) · 3.08 KB
Raw

Publish Package to npm

Web components for Radio4000

These components can be inserted in the HTML of any web pages, and are made to interact with Radio4000 through the use of its @radio4000/sdk, which talks to @radio4000/supabase.

Usage

Depending on whether you have a build system or not, you can either import the module from NPM, from a CDN or download it locally.

All methods are available on the imported sdk module.

With build system and NPM

import '@radio4000/components'
// use any <r4-component*> in your templates

With browser via CDN

<script type="module">
  import 'https://cdn.jsdelivr.net/npm/@radio4000/components'
  // use any <r4-*> component in your HTML
</script>

Changelog

See https://github.com/radio4000/components/releases

Development

  • The components are in the ./src folder
  • Inside ./examples you'll find demos of all components
  • The ./index.html file renders the <r4-app> component, which requires a SPA router.

If you'd like to help out, clone the repository, install dependencies and start the local server.

git clone [email protected]:radio4000/components.git radio4000-components
cd radio4000-components
npm install
npm run dev

Linting

Use npm run lint to check the project for potential code problems and style using eslint. It's configured to look out for web components, lit and jsdoc.

Themes

See the themes github repo

Build and releases

To release this package under @radio4000/components on NPM, bump the version in package.json, create a commit, tag it. Create a new release on Github and let the Github action publish it.

To make sure the build workflows:

Deploying to radio4000.com

To update radio4000.com, update the version of @radio4000/components on https://github.com/radio4000/radio4000.com.

Creating a new component

  • create a ./src/components/r4-*.js file
  • export default HTMLElement
  • import and export it in ./src/components/index.js
  • create an demo in ./examples/r4-*/index.html
  • reference the demo HTML page in ./vite.config.js

Connection to the Radio4000 database

All components use the @radio4000/sdk. The exact db is configured in https://github.com/radio4000/components/blob/main/src/libs/sdk.js.

Production

Currently deployed on cloudflare pages (which has the env vars manually added).

Github pages is not used because it does not support SPA redirects (like in the public folder for other hosting; @TODO: wait then migrate)