@ficusjs/script
v2.1.0
Published
FicusJS script is a loader for ES modules and ES5 Javascript
Downloads
1
Readme
FicusJS script loader
Lightweight script loader for lazy loading ES modules and ES5 scripts or both based on dynamic paths.
Features
- Lazy load ES modules
- Lazy load ES5 scripts
- Dynamically load based on path
- Functional programming patterns
- Small footprint (1.3 KB gzipped for everything!)
- No dependencies
- Works with client-side frameworks
Getting started
The easiest way to try out FicusJS script loader is using a simple example.
Create an index.html file and copy the following between the <body> tags.
<div id="content"></div>
<script type="module">
import { loadScript } from 'https://cdn.skypack.dev/@ficusjs/script@2'
const markdownToRender = `# FicusJS script loader
Dynamically load ES modules and ES5 scripts.
- Lazy load ES modules
- Lazy load ES5 scripts
- Dynamically load based on path
- Functional programming patterns
- Small footprint (1.3 KB gzipped for everything!)
- No dependencies
- Works with client-side frameworks
`
// load the ES module for marked
loadScript('https://unpkg.com/[email protected]/lib/marked.esm.js')
.then(mod => mod.default)
.then(marked => {
const content = document.getElementById('content')
content.innerHTML = marked(markdownToRender)
})
</script>Alternatively, fork this Codepen to see it in action - https://codepen.io/ducksoupdev/pen/abZbdbq
The example imports the marked ES module and converts some markdown to HTML.
Installation
FicusJS script loader can be installed in a number of ways.
CDN
We recommend using native ES modules in the browser.
<script type="module">
import { loadScript } from 'https://cdn.skypack.dev/@ficusjs/script@2'
</script>FicusJS script loader is available on Skypack.
NPM
FicusJS script loader works nicely with build tools such as Webpack or Rollup. If you are using a NodeJS tool, you can install the NPM package.
npm install @ficusjs/scriptAvailable builds
FicusJS script loader is only available as an ES module. For legacy browsers or alternative modules such as CommonJS, it is recommended to use a build tool to transpile the code.
Documentation
See the full documentation.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Contributing to FicusJS script
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.