coffeekraken-s-dialog-component

Coffeekraken s-dialog-component

Powerful, fully featured and easy to use dialog component

Features

1. Fully customizable
2. Support multiple content source (inline content / DOM element / Ajax request)
3. Support modal option
4. And more...

Table of content

1. Demo
2. Install
3. Get Started
4. Dialog types
5. Javascript API
6. Styling classes
7. Sugar Web Components Documentation
8. Browsers support
9. Contribute
10. Who are Coffeekraken?
11. Licence

Install

npm install coffeekraken-s-dialog-component --save

Get Started

First, import the component into your javascript file like so:

import SDialogComponent from 'coffeekraken-s-dialog-component'

Then simply use it inside your html like so:

<!-- inline content -->
<s-dialog id="my-cool-dialog">
	<template><!-- optional template tag -->
		<h1>Hello World</h1>
		<p>Phasellus nec dictum arcu, finibus semper tellus. Aliquam mattis dictum.</p>
	</template>
</s-dialog>
<a href="#my-cool-dialog">Click to open the dialog</a>

<!-- automatically opened dialog -->
<s-dialog opened content="data/my-cool-dialog.html"></s-dialog>

Dialog types

This webcomponent offers you multiple way to instanciate a dialog. Here's the list:

Dom component

Open a dialog using a dom component present in the page. This dom element can be a template tag too.

Iframe

Open a content inside an iframe. Usefull to load for example youtube/vimeo/etc... content

Modal

Open a dialog in modal mode. This mean that the user cannot close the dialog by clicking outside or by the escape key and your in full control of it's state

Ajax content

Open a dialog and load his content through an ajax request

Programatical dialog

Open a dialog fully programatically

Browsers support

IE / Edge	Firefox	Chrome	Safari
IE11+	last 2 versions	last 2 versions	last 2 versions

As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.

The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the corresponding polyfill.

Contribute

This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

1. Share the love ❤️
2. Declare issues
3. Fix issues
4. Add features
5. Build web component

Who are Coffeekraken

We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

More on who we are

License

The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...