Socket
Socket
Sign inDemoInstall

@uking/marmot

Package Overview
Dependencies
0
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @uking/marmot

A lightweight and fast javascript native template rendering engine that supports browsers, FibJS and NodeJS.


Version published
Maintainers
1
Install size
11.1 kB
Created

Readme

Source

@uking/marmot

A lightweight and fast javascript template rendering engine that supports browsers, FibJS and NodeJS.

Tips

  1. Component name must start with a capital letter
  2. Component name can not be Template or Slot
  3. Support for nested components
  4. Support for "v-if","v-else-if","v-else","v-for" directives
  5. Support for variable interpolation

render function

render(html`...`,components,data,context,slots)
  • html is a tagged template literal function that returns a Template object.
  • components is an object that contains all the required components.
  • data is an object that contains all the data for the template.
  • context is an object that contains the context for the template.
  • slots is an object that contains the slots for the template.

Install

npm install @uking/marmot
//or
yarn add @uking/marmot
//or
pnpm add @uking/marmot

Usage

const {html,Component,render} = require('@uking/marmot')

class Layout extends Component {
  data(){
    console.log(this.context)
    return{
      //
    }
  }
  render(){
    return html`
        <!DOCTYPE html>
        <html lang="en">
            <head>
                <meta charset="UTF-8">
                <title>{{title}}</title>
                <Slot name="header" />
            </head>
            <body>
                <Slot />
            </body>
        </html>
    `
  }
}

class Page extends Component {
  // Register required components
  components(){
    return {
      Layout
    }
  }
  data(){
    return {
      data:['test1','test2','test3'],
      color:'red',
      cls:"class test" //can not use "class" as a variable name in js
    }
  }
  render(){
    return html`
    	<Layout title="this is layout title">
    		<Template slot="header">
    			<style>
    			body{
    				font-size:16px;
    				color:{{color}};
    			}
    			</style>
    		</Template>
    		<h2>{{title}}</h2>
    		<div>this is body content</div>
            <ul>
                <li v-for="item in data" class="x" :class="cls">{{item}}</li>
            </ul>
    	</Layout>
    `
  }
}
let str = render(html`<Page title="this is Page title" />`,{Page})
console.log(str)
//or
let data = {
  color:'red',
  data:['test1','test2','test3']
}
// with context, the context can be passed to child components

let ctx = {
  a:1,
  b:2
}
let str2 = render(html`<Page title="Test" />`,{Page},data,ctx)
console.log(str2)


Keywords

FAQs

Last updated on 28 May 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc