@polight/lego

Version:

Tiny Web Components lib for future-proof HTML mentors

14 lines (12 loc) • 17.2 kB

HTML

<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1">  <title>Build Native Web-Components | 🚀 Lego Web-Components</title> <meta name="generator" content="Jekyll v4.2.2" /> <meta property="og:title" content="Build Native Web-Components" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Lego requires npm or yarn and node. By default Lego compiles HTML components from the HTML files within the /bricks folder. Create the folder to host your future components: mkdir bricks. Quick start Installation If you don’t have a package.json file yet, initialize first with npm init (or yarn init). Install the compiler with npm i @polight/lego (or yarn add @polight/lego). Basic Example This is the file tree we will need for this example: index.html |- bricks/ |- hello-world.html → The HTML you typed Hello World Create a file called bricks/hello-world.html: <script> const state = { name: "World!" } } </script> <template> <p>Hello ${ state.name }</p> </template> Compile with npx lego (or yarn lego) And use you component in your /index.html: <script src="./dist/index.js" type="module"></script> <hello-world></hello-world> Run a local web server, eg: npx sirv-cli and open http://localhost:5000. Let’s get a step back What did just happen? Here’s what you just did with this simple code: you created a native HTML element called hello-world by creating bricks/hello-world.html you made it react with a name state property you imported all components from ./dist/index.js (well, only 1 for now) you used the HTML element <hello-world></hello-world> No magic 🪄 here, just a couple of default configuration that you can override. You website is ready to be published on any static host, even Github Pages." /> <meta property="og:description" content="Lego requires npm or yarn and node. By default Lego compiles HTML components from the HTML files within the /bricks folder. Create the folder to host your future components: mkdir bricks. Quick start Installation If you don’t have a package.json file yet, initialize first with npm init (or yarn init). Install the compiler with npm i @polight/lego (or yarn add @polight/lego). Basic Example This is the file tree we will need for this example: index.html |- bricks/ |- hello-world.html → The HTML you typed Hello World Create a file called bricks/hello-world.html: <script> const state = { name: "World!" } } </script> <template> <p>Hello ${ state.name }</p> </template> Compile with npx lego (or yarn lego) And use you component in your /index.html: <script src="./dist/index.js" type="module"></script> <hello-world></hello-world> Run a local web server, eg: npx sirv-cli and open http://localhost:5000. Let’s get a step back What did just happen? Here’s what you just did with this simple code: you created a native HTML element called hello-world by creating bricks/hello-world.html you made it react with a name state property you imported all components from ./dist/index.js (well, only 1 for now) you used the HTML element <hello-world></hello-world> No magic 🪄 here, just a couple of default configuration that you can override. You website is ready to be published on any static host, even Github Pages." /> <link rel="canonical" href="http://localhost:4000/v2/getting-started/" /> <meta property="og:url" content="http://localhost:4000/v2/getting-started/" /> <meta property="og:site_name" content="🚀 Lego Web-Components" /> <meta property="og:type" content="article" /> <meta property="article:published_time" content="2023-03-03T20:30:45+01:00" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="Build Native Web-Components" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"BlogPosting","dateModified":"2023-03-03T20:30:45+01:00","datePublished":"2023-03-03T20:30:45+01:00","description":"Lego requires npm or yarn and node. By default Lego compiles HTML components from the HTML files within the /bricks folder. Create the folder to host your future components: mkdir bricks. Quick start Installation If you don’t have a package.json file yet, initialize first with npm init (or yarn init). Install the compiler with npm i @polight/lego (or yarn add @polight/lego). Basic Example This is the file tree we will need for this example: index.html |- bricks/ |- hello-world.html → The HTML you typed Hello World Create a file called bricks/hello-world.html: <script> const state = { name: "World!" } } </script> <template> <p>Hello ${ state.name }</p> </template> Compile with npx lego (or yarn lego) And use you component in your /index.html: <script src="./dist/index.js" type="module"></script> <hello-world></hello-world> Run a local web server, eg: npx sirv-cli and open http://localhost:5000. Let’s get a step back What did just happen? Here’s what you just did with this simple code: you created a native HTML element called hello-world by creating bricks/hello-world.html you made it react with a name state property you imported all components from ./dist/index.js (well, only 1 for now) you used the HTML element <hello-world></hello-world> No magic 🪄 here, just a couple of default configuration that you can override. You website is ready to be published on any static host, even Github Pages.","headline":"Build Native Web-Components","mainEntityOfPage":{"@type":"WebPage","@id":"http://localhost:4000/v2/getting-started/"},"url":"http://localhost:4000/v2/getting-started/"}</script>  </head> <link rel="stylesheet" href="/assets/css/style.css" /> <body> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header"> <a href="http://localhost:4000/" class="site-title lh-tight"> 🚀 Lego </a> <a href="#" id="menu-button" class="site-button"> <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-menu"></use></svg> </a> </div> <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav"> <div class="nav-category">v2.0 - alpha</div> <ul class="nav-list"><li class="nav-list-item"><a href="http://localhost:4000/v2/" class="nav-list-link">Welcome</a></li><li class="nav-list-item active"><a href="http://localhost:4000/v2/getting-started/" class="nav-list-link active">Getting Started</a></li><li class="nav-list-item"><a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a><a href="http://localhost:4000/v2/usage-web-components/" class="nav-list-link">Usage</a><ul class="nav-list "><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/template/" class="nav-list-link">Template tag</a></li><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/condition/" class="nav-list-link">Condition :if</a></li><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/loop/" class="nav-list-link">Loop :for</a></li><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/custom-directive/" class="nav-list-link">Custom directives</a></li><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/events/" class="nav-list-link">Binding events</a></li><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/reactive/" class="nav-list-link">Reactive properties</a></li><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/attributes/" class="nav-list-link">Pass attributes</a></li><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/slots/" class="nav-list-link">Using slots</a></li><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/reactive-css/" class="nav-list-link">Reactive CSS</a></li><li class="nav-list-item "><a href="http://localhost:4000/v2/usage-web-components/script-tag/" class="nav-list-link">Script Tag</a></li></ul></li><li class="nav-list-item"><a href="http://localhost:4000/v2/naming-components/" class="nav-list-link">Naming Conventions</a></li><li class="nav-list-item"><a href="http://localhost:4000/v2/compile-components/" class="nav-list-link">Compiling</a></li><li class="nav-list-item"><a href="http://localhost:4000/v2/configuring-components/" class="nav-list-link">Configuring</a></li><li class="nav-list-item"><a href="http://localhost:4000/v2/advanced-components/" class="nav-list-link">Advanced Example</a></li><li class="nav-list-item"><a href="http://localhost:4000/v2/testing-components/" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="http://localhost:4000/v2/advanced-webcomponents/" class="nav-list-link">Getting deep</a></li></ul> </nav> <footer class="site-footer"> <p>Version 2.0 pre-release</p> <p>Based on <a href="https://jekyllrb.com/">Jekyll</a> and <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>.</p> </footer> </div> </section> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search"> <div class="search-input-wrap"> <input type="search" id="search-input" class="search-input" tabindex="0" placeholder="Search the Lego documentation" aria-label="Search " autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> </div> <div id="main-content-wrap" class="main-content-wrap"> <div id="main-content" class="main-content" role="main"> <p>Lego requires <a href="https://npmjs.com">npm</a> or <a href="https://yarnpkg.com">yarn</a> and <a href="https://nodejs.org/">node</a>.</p> <p>By default Lego compiles HTML components from the HTML files within the <em>/bricks</em> folder. Create the folder to host your future components: <code class="language-plaintext highlighter-rouge">mkdir bricks</code>.</p> <h2 id="quick-start"> <a href="#quick-start" class="anchor-heading" aria-labelledby="quick-start"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Quick start </h2> <h3 id="installation"> <a href="#installation" class="anchor-heading" aria-labelledby="installation"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Installation </h3> <p>If you don’t have a <em>package.json</em> file yet, initialize first with <code class="language-plaintext highlighter-rouge">npm init</code> (or <code class="language-plaintext highlighter-rouge">yarn init</code>).</p> <p>Install the compiler with <code class="language-plaintext highlighter-rouge">npm i @polight/lego</code> (or <code class="language-plaintext highlighter-rouge">yarn add @polight/lego</code>).</p> <h3 id="basic-example"> <a href="#basic-example" class="anchor-heading" aria-labelledby="basic-example"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Basic Example </h3> <p>This is the file tree we will need for this example:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>index.html |- bricks/ |- hello-world.html → The HTML you typed </code></pre></div></div> <h3 id="hello-world"> <a href="#hello-world" class="anchor-heading" aria-labelledby="hello-world"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Hello World </h3> <p>Create a file called <strong>bricks/hello-world.html</strong>:</p> <div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><script></span> <span class="kd">const</span> <span class="nx">state</span> <span class="o">=</span> <span class="p">{</span> <span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">World!</span><span class="dl">"</span> <span class="p">}</span> <span class="p">}</span> <span class="nt"></script></span> <span class="nt"><template></span> <span class="nt"><p></span>Hello ${ state.name }<span class="nt"></p></span> <span class="nt"></template></span> </code></pre></div></div> <p>Compile with <code class="language-plaintext highlighter-rouge">npx lego</code> (or <code class="language-plaintext highlighter-rouge">yarn lego</code>)</p> <p>And use you component in your <em>/index.html</em>:</p> <div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><script </span><span class="na">src=</span><span class="s">"./dist/index.js"</span> <span class="na">type=</span><span class="s">"module"</span><span class="nt">></script></span> <span class="nt"><hello-world></hello-world></span> </code></pre></div></div> <p>Run a local web server, eg: <code class="language-plaintext highlighter-rouge">npx sirv-cli</code> and open http://localhost:5000.</p> <h2 id="lets-get-a-step-back"> <a href="#lets-get-a-step-back" class="anchor-heading" aria-labelledby="lets-get-a-step-back"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Let’s get a step back </h2> <p>What did just happen?</p> <p>Here’s what you just did with this simple code:</p> <ol> <li>you created a native HTML element called <code class="language-plaintext highlighter-rouge">hello-world</code> by creating <em>bricks/hello-world.html</em></li> <li>you made it react with a <code class="language-plaintext highlighter-rouge">name</code> state property</li> <li>you imported all components from <code class="language-plaintext highlighter-rouge">./dist/index.js</code> (well, only 1 for now)</li> <li>you used the HTML element <code class="language-plaintext highlighter-rouge"><hello-world></hello-world></code></li> </ol> <p>No magic 🪄 here, just a couple of <a href="/configuring-components/">default configuration that you can override</a>.</p> <p>You website is ready to be published on any <em>static</em> host, even Github Pages.</p> <hr> <footer> <p class="text-small text-grey-dk-100 mb-0">Lego is <a href=https://github.com/polight/lego>open-source</a>. Distributed under <a href="https://github.com/polight/lego/tree/master/LICENSE.txt">MIT license.</a></p> <div class="d-flex mt-2"> </div> </footer> </div> </div> <a href="#" id="search-button" class="search-button"> <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-search"></use></svg> </a> <div class="search-overlay"></div> </div> </body> </html>