Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
boikom committed Dec 10, 2018
1 parent cdb9796 commit 37b9268
Show file tree
Hide file tree
Showing 6 changed files with 183 additions and 2 deletions.
86 changes: 84 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,84 @@
# smart-tooltip
Tooltip Web Component
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/htmlelements/smart-tooltip)

# <smart-tooltip>

[Live Demo ↗](https://htmlelements.com/demos/tooltip/)
|
[Documentation ↗](https://www.htmlelements.com/docs/)
|
[Installation ↗](https://www.npmjs.com/package/@smarthtmlelements/smarthtmlelements-core)

[<smart-tooltip>](https://htmlelements.com/demos/tooltip/) is a Custom HTML Element providing slide show/banner rotator](https://htmlelements.com/).

<!--
```
<custom-element-demo>
<template>
<script src="../webcomponentsjs/webcomponents-lite.js"></script>
<script src="../smart-core/source/smart.core.js"></script>
<link rel="stylesheet" href="../smart-core/source/styles/smart.default.css" type="text/css" />
<script>
window.onload = function () {
}
</script>
<next-code-block></next-code-block>
</template>
</custom-element-demo>
```
-->
```html
<smart-button id="button">Button</smart-button>
<smart-tooltip id="tooltip" selector="button" arrow>This is a tooltip for smartButton</smart-tooltip>
```

[<img src="https://raw.githubusercontent.com/htmlelements/smart-tooltip/master/tooltip-web-component.png" alt="Screenshot of smart-tooltip">](https://htmlelements.com/demos/tooltip)

## Getting Started

Smart HTML Elements components documentation includes getting started, customization and api documentation topics.

[Getting Started Documentation](https://www.htmlelements.com/docs/)


## The file structure for Smart HTML Elements

- `source/`

Javascript files.

- `source/styles/`

Component CSS Files.

- `demos/`

Demo files

## Running demos in browser

1. Fork the `Smart-HTML-Elements-Core` repository and clone it locally.

1. Make sure you have [npm](https://www.npmjs.com/) installed.

1. When in the `Smart-HTML-Elements-Core` directory, run `npm install` and then `bower install` to install dependencies.

1. Run a localhost or upload the demo on a web server. Then run:

- /demos/smart-tooltip/smart-tooltip-overview.htm


## Following the coding style

We are using [ESLint](http://eslint.org/) for linting JavaScript code.

## Creating a pull request

- Make sure your code is compliant with ESLint
- [Submit a pull request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description
- Wait for response from one of our team members


## License

Apache License 2.0
25 changes: 25 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "smart-tooltip",
"authors": [
"jQWidgets Ltd"
],
"description": "Smart Tooltip is a free Tooltip Element, built using native Javascript and CSS.",
"license": "Apache-2.0",
"keywords": [
"smart Tooltip",
"Tooltip",
"Tooltip Web Component",
"Tooltip Custom Element"
],
"main": "",
"ignore": [
"**/.*",
"**/node_modules",
"**/bower_components",
"**/tests"
],
"dependencies": {
"webcomponentsjs": "^1.0.0",
"smart-core": "HTMLElements/smart-core"
}
}
20 changes: 20 additions & 0 deletions demos/smart-tooltip-overview.htm
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/webcomponentsjs/1.0.22/webcomponents-lite.js"></script>

<link rel="stylesheet" href="../../smart-core/source/styles/smart.default.css" type="text/css" />
<!--! do not remove -->
<link rel="stylesheet" href="../styles/demos.css" type="text/css" />
<script type="text/javascript" src="../../smart-core/source/smart.core.js"></script>
<script>
window.onload = function () {

}
</script>
</head>
<body>
<smart-button id="button">Button</smart-button>
<smart-tooltip id="tooltip" selector="button" arrow>This is a tooltip for smartButton</smart-tooltip>
</body>
</html>
46 changes: 46 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"name": "@smarthtmlelements/smart-tooltip",
"version": "2.0.0",
"description": "Smart Tooltip",
"scripts": {
},
"repository": {
"type": "git",
"url": "git+https://github.com/HTMLElements/smart-tooltip.git"
},
"author": "Smart HTML Elements",
"license": "SEE LICENSE IN https://www.htmlelements.com/license/",
"bugs": {
"url": "https://github.com/HTMLElements/smart-tooltip"
},
"homepage": "https://github.com/HTMLElements/smart-tooltip#readme",
"devDependencies": {

},
"dependencies": {
"@webcomponents/webcomponentsjs": "^1.0.22",
"@smarthtmlelements/smart-core": "^2.0.0"
},
"main": "index.js",
"directories": {},
"keywords": [
"custom",
"element",
"tooltip custom element",
"html tooltip",
"tooltip",
"web components tooltip",
"tooltip element",
"banner rotator",
"custom tooltip",
"tooltip widget",
"tooltip ui",
"tooltip component",
"tooltip control",
"banner",
"banner element",
"banner user interface",
"material banner",
"material tooltip"
]
}
8 changes: 8 additions & 0 deletions styles/demos.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
smart-carousel {
width: 1000px;
height: 450px;
border-width: 0px;
margin-left: auto;
margin-right: auto;
background-color: #d3d3d369;
}
Binary file added tooltip-web-component.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 37b9268

Please sign in to comment.