FicusJS renderers

Minified ES module renderers for FicusJS.

This package provides a tested set of renderers as ES modules to make working with them much easier.

Getting started

A renderer function can be provided when creating a new FicusJS component. This allows any renderer to be plugged into a component.

The following renderers have been tested with FicusJS and are available as minified bundles in this package to make working with them much easier.

htm (JSX-like syntax - no transpiler necessary) - 923 B gzipped
htm with Preact (JSX-like syntax - no transpiler necessary) - 4.45 KB gzipped
lit-html - 3.21 KB gzipped
uhtml - 2.71 KB gzipped
css - 204 B gzipped

htm

The htm renderer is a JSX-like renderer available in this package.

import { html, renderer } from 'https://cdn.skypack.dev/@ficusjs/renderers@5/htm'

createComponent('test-comp', {
  renderer,
  render () {
    return html`
      <div>Some HTML content with ${someVariable}</div>
    `
  }
})

htm with Preact

The htm with Preact renderer is available in this package.

import { html, renderer } from 'https://cdn.skypack.dev/@ficusjs/renderers@5/htm-preact'

createComponent('test-comp', {
  renderer,
  render () {
    return html`
      <div>Some HTML content with ${someVariable}</div>
    `
  }
})

lit-html

The lit-html renderer is available in this package.

import { html, renderer } from 'https://cdn.skypack.dev/@ficusjs/renderers@5/lit-html'

createComponent('test-comp', {
  renderer,
  render () {
    return html`
      <div>Some HTML content with ${someVariable}</div>
    `
  }
})

uhtml

The uhtml renderer is available in this package.

import { html, renderer } from 'https://cdn.skypack.dev/@ficusjs/renderers@5/uhtml'

createComponent('test-comp', {
  renderer,
  render () {
    return html`
      <div>Some HTML content with ${someVariable}</div>
    `
  }
})

css

The css renderer is available in this package and is intended for rendering CSS styles within a component.

This renderer is used in conjunction with the withStyles component extension.

// import the css tagged template literal
import { css } from 'https://cdn.skypack.dev/@ficusjs/renderers@5/css'

createCustomElement(
  'test-comp',
  withStyles({
    renderer,
    styles () {
      return css`
        test-comp div {
          background-color: purple;
          color: pink
        }
      `
    },
    render () {
      return html`
        <div>Some HTML content with ${someVariable}</div>
      `
    }
  })
)

Installation

FicusJS renderers can be installed in a number of ways.

CDN

We recommend using native ES modules in the browser.

<script type="module">
  import { html, renderer } from 'https://cdn.skypack.dev/@ficusjs/renderers@5/uhtml'
</script>

FicusJS renderers is available on Skypack.

NPM

FicusJS renderers work 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/renderers

Available builds

FicusJS renderers 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 renderers for local development.

Clone the repository:

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

Change the working directory

cd ficusjs-renderers

Install dependencies

npm install

Run the local development server

npm run 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 renderers

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.

ficusjs / ficusjs-renderers Goto Github PK