Skip to content

Installation

Ethan Finley edited this page Jun 30, 2020 · 2 revisions

Before using iBox, you should install or include the library in your website project. There are many ways for doing this, but I tried to explain 3 of them in the following.

With NPM

For this way a package.json file is required in your working directory. I recommend to also use a asset bundler, like Webpack or Laravel Mix.

  • Run npm install ibox-modal
  • include the JavaScript in your main JS file
require("ibox-modal")
  • include the SCSS in your main SCSS file
@import "~ibox-modal/src/ibox.scss";

If you do not use a bundler, you could link the compiled files directly from the node_modules directory.

With Yarn

This package is also available in the Yarn package registry. I have never tested and used Yarn, so I do not know if everything works.

Thank you for your understanding.

Include In The Browser

  • download the required JS and CSS files from the last releases and save these in your website directory
  • import the CSS file in the HTML head
<html>
	<head>
		...
		<link rel="stylesheet" href="path/to/ibox.css">
		...
	</head>
	<body>
		...
	</body>
</html>
  • import the JS file somewhere in the HTML body (I recommend at the end)
<html>
	<head>
		...
	</head>
	<body>
		...
		<script src="path/to/ibox.js"></script>
	</body>
</html>

Now you have included iBox in your page. Let's go on with the basic usage.

Content

Home

The Basics

Installation

Basic Usage

Versions and Upgrade

Change Log

Migration From Version 2.x / 1.x

Clone this wiki locally