Ice Core
Ice Core provides the core Ice web component library.
Each web component comes with its own functional styling which can be customised as needed.
Installing
To install the web component library you can use Node Package Manager.
npm install "@futurice/ice-core" --save-dev
Usage
To use the project reference the full library:
<script type="module"
src="node_modules/ice-core/lib/ice-core.es.js"></script>
Then you can use a component (e.g. a button) as follows in a HTML document:
<ice-button id="primary-button" />
Or programmatically as follows:
const button = new IceButton();
Building
To build the project you can use Node Package Manager.
npm run clean && npm run build
Developing
To get started in developing the project it's recommended to use the official Node Docker image, as this will provide a consistent and reliable environment for developing and testing changes. It's the exact image the project uses as part of the continuous integration (CI) build pipeline.
To start with Docker you can use the following command-line statement.
The project is built using Vite and the configuration can be found in the build directory (along with any other build-specific files).
For further details on contributing to this project, follow the CONTRIBUTING guide.
docker run -it --name "ice-node" -P -v $(pwd):/src node:16-alpine sh; docker rm "ice-node"
Note: The statement automatically removes the Docker image after use through the post-fixed
docker rm ...command. If you want to keep the image, remove the post-fix statement and continue.
7 Aug 26, 2022
24 Dec 3, 2022
51 Jan 2, 2023
6 Jul 19, 2022
13 Oct 23, 2022
2 Dec 24, 2021
109 Dec 9, 2022
8 Mar 15, 2022
29 Jan 9, 2023
8 Aug 17, 2022