A web component to include in your JS/TS projects. Your users can create an expression or a ordoned list with your data as a tree.
It implements the same API as HTML inputs and can be used in a form.
This is part of a bigger project: Silex no-code website builder
This feature is made of these components
- [x]
<popin-overlay>behaves like a popin, disapears when it loses the focus - [x]
<popin-form>extends the<popin-overlay>component, behaves both like a form and like an input for a parent form - [ ]
<custom-select>can replace native<select>in the<input-chain>component, with label, options and help buttons - [ ]
<custom-option>a custom version of theoptiontag for use with the<custom-select>component - [ ]
<custom-optgroup>a custom version of theoptgrouptag for use with the<custom-select>component - [ ]
<input-chain>behaves like a select input with multi-selection but looks like a chain of<select>inputs - [x]
<expression-input>extends<input-chain>and handles fixed values UI
Use cases
- Build an expression the no-code way - e.g.
obj.prop1.subProp(js),posts | where: 'id', '123'(liquidjs) - Select a folder in a file system
- Make decisions in a decision tree
Project
- [x] Licence AGPL
- [x] publish to npm
- [ ] Unit tests still fail on github actions (playwrite issue)
Popin
- [x] Display where placed
- [x] Handle focus
Selector
- [x] values: icon, name (may be a function of options), tags, options, optionsForm, type, helpText (with html links to directus collection)
- [x] callback getNextChoices(pastChoices)
- [x] message (if error or warning)
- [x] events: change
- [x] styling
- [ ] copy / paste / set / unset
- [ ] result (the final value resulting the current choices)
- [ ] state: valid, warning, error
SelectorItem
- [x] value
- [x] events: set, unset
- [x] openChoices/close, openOptions/close
- [x] state
- [x] message
- [x] helpText
Install the npm package in your project
$ npm install --save @silexlabs/expression-inputInclude the library with ESNext import "@silexlabs/expression-input" or directly in the HTML with <script src="/path/to/expression-input.js"></script>
Use in your HTML as a web component:
<html><body>
<expression-input name="form-data-name" onload="initStepSelector(event.target)"></expression-input>
<expression-input name="form-data-name" onload="initStepSelector(event.target)">
Label
</expression-input>The expression-input component has these events:
- load
- change
It has these attributes:
- fixed
- fixed-type: 'none' | 'text' | 'date' | 'email' | 'number' | 'password' | 'tel' | 'time' | 'url' = 'text'
- reactive: boolean = false, if true, the component will not update the DOM when the value changes, you need to listen to the
changeevent and update the DOM yourself - select-tag-name (default: select) to change the tag name of the select elements
- option-tag-name (default: option) to change the tag name of the option elements
It has these properties:
- steps
- dirty
- completion
It has these slots:
- placeholder
- dirty-icon
The property completion is a function you need to provide to the component so that it knows what can be selected at each steps:
function initStepSelector(stepsSelector) {
// [Optional] Initial state
stepsSelector.steps = [
// ... Initial selection here
]
// [Optional] Reset dirty flag and store the current value as initial value
stepsSelector.save()
// [Required] Provide the completion fucntion
stepsSelector.completion = (steps) => {
// In this example just return the same for each step
return [{
name: 'Posts',
icon: '',
type: 'Collection',
tags: [],
helpText: 'Some text with <a href="#">html links</a>',
errorText: 'Some error text',
}]
}
}Install dependencies:
npm iThis sample uses the TypeScript compiler to produce JavaScript that runs in modern browsers.
To build the JavaScript version of your component:
npm run buildTo watch files and rebuild when the files are modified, run the following command in a separate shell:
npm run build:watchBoth the TypeScript compiler and lit-analyzer are configured to be very strict. You may want to change tsconfig.json to make them less strict.
This sample uses modern-web.dev's @web/test-runner for testing. See the modern-web.dev testing documentation for more information.
Tests can be run with the test script, which will run your tests against Lit's development mode (with more verbose errors) as well as against Lit's production mode:
npm testFor local testing during development, the test:dev:watch command will run your tests in Lit's development mode (with verbose errors) on every change to your source files:
npm test:watchAlternatively the test:prod and test:prod:watch commands will run your tests in Lit's production mode.
This sample uses modern-web.dev's @web/dev-server for previewing the project without additional build steps. Web Dev Server handles resolving Node-style "bare" import specifiers, which aren't supported in browsers. It also automatically transpiles JavaScript and adds polyfills to support older browsers. See modern-web.dev's Web Dev Server documentation for more information.
To run the dev server and open the project in a new browser tab:
npm run serveThere is a development HTML file located at /dev/index.html that you can view at http://localhost:8000/dev/index.html. Note that this command will serve your code using Lit's development mode (with more verbose errors). To serve your code against Lit's production mode, use npm run serve:prod.
If you use VS Code, we highly recommend the lit-plugin extension, which enables some extremely useful features for lit-html templates:
- Syntax highlighting
- Type-checking
- Code completion
- Hover-over docs
- Jump to definition
- Linting
- Quick Fixes
The project is setup to recommend lit-plugin to VS Code users if they don't already have it installed.
Linting of TypeScript files is provided by ESLint and TypeScript ESLint. In addition, lit-analyzer is used to type-check and lint lit-html templates with the same engine and rules as lit-plugin.
The rules are mostly the recommended rules from each project, but some have been turned off to make LitElement usage easier. The recommended rules are pretty strict, so you may want to relax them by editing .eslintrc.json and tsconfig.json.
To lint the project run:
npm run lintPrettier is used for code formatting. It has been pre-configured according to the Lit's style. You can change this in .prettierrc.json.
Prettier has not been configured to run when committing files, but this can be added with Husky and pretty-quick. See the prettier.io site for instructions.
This project includes a simple website generated with the eleventy static site generator and the templates and pages in /docs-src. The site is generated to /docs and intended to be checked in so that GitHub pages can serve the site from /docs on the master branch.
To enable the site go to the GitHub settings and change the GitHub Pages "Source" setting to "master branch /docs folder".
To build the site, run:
npm run docsTo serve the site locally, run:
npm run docs:serveTo watch the site files, and re-build automatically, run:
npm run docs:watchThe site will usually be served at http://localhost:8000.
Note: The project uses Rollup to bundle and minify the source code for the docs site and not to publish to NPM. For bundling and minification, check the Bundling and minification section.
As stated in the static site generation section, the bundling and minification setup in the Rollup configuration in this project is there specifically for the docs generation.
We recommend publishing components as unoptimized JavaScript modules and performing build-time optimizations at the application level. This gives build tools the best chance to deduplicate code, remove dead code, and so on.
Please check the Publishing best practices for information on publishing reusable Web Components, and Build for production for building application projects that include LitElement components, on the Lit site.
See Get started on the Lit site for more information.