README

FicusJS

FicusJS is a set of lightweight functions for developing modern web applications using web components.

Features

FicusJS provides the following features for building modern web applications.

Fast lightweight web components
Extending web components
- with renderers
- with local state
- with styles
- with lazy rendering
- with breakpoint rendering
- with a state machine
- with an XState service
- with an application state store
- with an event bus
- with internationalization (i18n)
Fast lightweight publish/subscribe event bus
Fast lightweight stores for managing application state

Documentation

See the full documentation.

Getting started

The easiest way to try out FicusJS is using a hello world example.

Create an index.html file and copy the following between the <body> tags.

<hello-world></hello-world>

<script type="module">
import { html, renderer } from 'https://cdn.skypack.dev/@ficusjs/renderers@4/htm'
import { createCustomElement } from 'https://cdn.skypack.dev/ficusjs@3/custom-element'

createCustomElement('hello-world', {
  renderer,
  handleClick () {
    window.alert('Hello to you!')
  },
  render () {
    return html`
    <div>
      <p>FicusJS hello world</p>
      <button type="button" onclick="${this.handleClick}">Click me</button>
    </div>
  `
  }
})
</script>

Alternatively, fork this Codepen to see it in action - https://codepen.io/ducksoupdev/pen/GRZPqJO

The hello world example creates a new custom element using the createCustomElement function and registers it to the hello-world tag. It uses the htm JSX-like renderer (other renderers are available) for creating HTML from tagged template literals.

Once registered, the tag can be used multiple times in HTML and instances can be programmatically obtained using document.querySelector or element.querySelector.

Installation

FicusJS can be installed in a number of ways.

CDN

We recommend using native ES modules in the browser.

<script type="module">
  import { createCustomElement } from 'https://cdn.skypack.dev/ficusjs@3/custom-element'
</script>

FicusJS is available on Skypack.

NPM

FicusJS works nicely with build tools such as Snowpack, Webpack or Rollup. If you are using a NodeJS tool, you can install the NPM package.

npm install ficusjs

Available builds

FicusJS only provides ES module builds. For legacy browsers or alternative modules such as CommonJS, it is recommended to use a build tool to transpile the code.

Development

How to set-up FicusJS for local development.

Clone the repository:

git clone https://github.com/ficusjs/ficusjs.git

Change the working directory

cd ficusjs

Install dependencies

npm install # or, yarn install

Run the local development server

npm run dev # or, yarn dev

That's it! Now open http://localhost:8080 to see a local app.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing to FicusJS

Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.

If you wish to contribute, you can work on any features you think would enhance the library. After adding your code, please send us a Pull Request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

Support

We all need support and motivation. FicusJS is not an exception. Please give this project a ⭐️ to encourage and show that you liked it. Don't forget to leave a star ⭐️ before you move away.

If you found the library helpful, please consider sponsoring us.

Usage no npm install needed!