# Chardin.js
**Simple overlay instructions for your apps.**
[Check out a demo](http://heelhook.github.com/chardin.js/).
[Or demo sequential stepping](http://heelhook.github.com/chardin.js/sequential.html).
Chardin.js is a jQuery plugin that creates a simple overlay to display instructions on existent elements. It is inspired by
the recent Gmail new composer tour which I loved.
[Jean-Baptiste-Siméon Chardin](http://en.wikipedia.org/wiki/Jean-Baptiste-Sim%C3%A9on_Chardin)
## Installing
Simple! Fork this repo or download [chardinjs.css][0] and [chardinjs.min.js][1] and add the following assets to your HTML:
```HTML
<link href="chardinjs.css" rel="stylesheet">
<script src="chardinjs.min.js"></script>
```
There's a [`chardinjs-rails`](https://github.com/heelhook/chardin.js-rails) gem.
## Adding data for the instructions
Add the instructions to your elements:
`data-intro`: Text to show with the instructions/tooltip.
`data-position`: (`left`, `top`, `right`, `bottom`), where to place the text with respect to the element.
In addition you can alter the relative position of the tooltip text by placing a colon and a percentage value (-100 to 100) after the position text, eg "top:-50".
This will slide the tooltip along the length or height of the element away from the centre.
If you want to increae the distance of the tooltip from the element, you can do it by placing a comma and a percentage value (100, 200, 300, 400 or 500) after the tooltip offset, eg "top:0,200". This will shift the tooltip to be twice farther away from the element than by default.
```HTML
<img src="img/chardin.png" data-intro="An awesome 18th-century painter, who found beauty in everyday, common things." data-position="right" />
```
You can also run Chardin in sequenced mode, where one element will be displayed at a time, moving on to the next with a mouse click (or automatically after a set delay).
Add `data-chardin-sequenced="true"` entry to the body tag. Also add `data-chardin-auto="true"` and `data-chardin-delay="100"` for automatic movement through the elements. Delay is in milliseconds.
The default sequence is as loaded by the DOM, but this can be overridden using the tag `data-sequence` with a number.
If no auto-traversal is set, clicking will move sequentially through the elements, clicking with the shift key down will move backwards through them.
```HTML
<body data-chardin-sequenced="true" data-chardin-auto="false" data-chardin-delay="800" >
```
## Running
Once you have your elements ready, initialise the library and assign it to a button that the user will click to show the overlay.
The library will store an initialised object to the containing element's data set so you can start and stop it with whatever options you set.
```Javascript
$('body').chardinJs();
$('body').on('click', 'button[data-toggle="chardinjs"]', function (e) {
e.preventDefault();
return ($('body').data('chardinJs')).toggle();
});
````
You can run it explicitly like so:
```Javascript
$('body').chardinJs('start')
```
If you would rather run ChardinJs confined to a particular container (instead of using the whole document) you can
change `body` to some other selector.
```Javascript
$('.container').chardinJs('start')
```
You may also refresh instructions overlay any time to reflect whatever changes happened to the underlying page elements since the instructions overlay has been displayed.
```Javascript
var chardinOverlay = $('body').chardinJs('start');
...
chardinOverlay.refresh();
```
## Options
The chardinJS constructor can take several options, eg:
```Javascript
$('body').chardinJs({ url: "/help/HelpOverlay.json" });
```
Options are:
- url: specifies a url that returns a json object containing text to show. This is useful to dynamically change the overlay, or to hold all your overlay text in one external file.
The json file should contain a set of name-value pairs, the name will match the data-intro attribute if it begins with a '#'. The value contains the required text and an optional posiiton.
For conflicts between the data attributes and the json entries, the attribute takes precedence.
Example:
```json
{
"#summary-btns": {
"text": "buttons to interact with the displayed summary",
"position": "left"
},
"#search-btn": {
"text": "expand this to filter the list of profiles"
}
}
```
This text will be shown against an element that has `data-intro='#summary-btns'`. If the data-intro does not start with a #, then the value will be used as the text to display.
If no entry is present for a given element's data reference, then nothing will be displayed.
- attribute: changes the data attribute from data-intro to data-<as specified>.
Example:
```Javascript
$('body').chardinJs({ attribute: 'data-intro' });
```
## Methods
### .chardinJs('start')
Start ChardinJs in the selector.
### .chardinJs('toggle')
Toggle ChardinJs.
### .chardinJs('stop')
Make your best guess. That's right! Stops ChardinJs in the selector.
## Events
### 'chardinJs:start'
Triggered when chardinJs is correctly started.
### 'chardinJs:stop'
Triggered when chardinJs is stopped.
### 'chardinJs:next'
Triggered when the sequential option moves to the next element
### 'chardinJs:previous'
Triggered when the sequential option moves to the previous element
## Author
[Pablo Fernandez][2]
### Contributors
* [John Weir](https://github.com/jweir)
* [felipeclopes](https://github.com/felipeclopes)
* [Bobby Jack](https://github.com/fiveminuteargument)
* [Maxim Syabro](https://github.com/syabro)
* [nmeum](https://github.com/nmeum)
* [printercu](https://github.com/printercu)
* [Max Loginov](https://github.com/maxloginov)
* [sudodoki](https://github.com/sudodoki)
* [Mickaël Gentil](https://github.com/yudao)
* [gbjbaanb](https://github.com/gbjbaanb)
* [dozyatom](https://github.com/dozyatom)
## Contributions
If you want to contribute, please:
* Fork the project.
* Make your feature addition or bug fix.
* Add yourself to the list of contributors in the README.md.
* Send me a pull request on Github.
## License
Copyright 2020 Pablo Fernandez
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
[0]: https://github.com/heelhook/chardin.js/blob/master/chardinjs.css
[1]: https://github.com/heelhook/chardin.js/blob/master/chardinjs.min.js
[2]: https://github.com/heelhook
面向生产环境的 MySQL,MariaDB,kafka 同步到Redis,MongoDB,ClickHouse等服务的异构中间件 （478个子文件） 
Bifrost-server.bat 56B Bifrost-server 3KB server.crt 1KB bootstrap.min14ed.css 118KB style.min862f.css 97KB bootstrap-table.min.css 4KB chardinjs.css 3KB font-awesome.min93e3.css 0B Dockerfile 216B Gemfile 94B .gitignore 64B static.go 396KB index.html.go 76KB data.go 69KB debezium_json_test.go 57KB MySQL_Filed_DataCheck.go 38KB mysql.go 27KB clickhouse.go 26KB db.go 26KB packets.go 25KB recovery.go 22KB clickhouse_test.go 22KB to_server_consume.go 20KB event_row.go 20KB transfer.go 20KB parser.go 19KB mysql_integration_test.go 19KB auth.go 14KB es_test.go 14KB alter_sql_test.go 13KB init.go 13KB history_test.go 12KB input_test.go 12KB callback_test.go 12KB customer_json_test.go 12KB alter_sql.go 12KB es.go 12KB utils.go 11KB input_min_position_test.go 11KB test_data.go 11KB driver.go 11KB driver.go 11KB BristolPerformanceTest.go 11KB mysql_sql.go 11KB transfer.go 11KB transfer_test.go 10KB select.go 10KB conn_dump.go 10KB pprof.go 10KB canal_json_test.go 10KB binlog.go 10KB channel_consume.go 10KB connection.go 10KB batch_test.go 10KB flow.go 9KB db.go 9KB kafka.go 9KB debezium_json.go 8KB driver.go 8KB router.go 8KB schema.go 8KB field_type_json_format.go 8KB router.go 8KB etc_init.go 8KB db_detail.go 8KB replicate.go 8KB history.go 8KB debezium_data_type_transfer.go 8KB cosume.go 7KB recovery_test.go 7KB input.go 7KB const.go 7KB Bifrost.go 7KB table_sync.go 7KB count.go 7KB callback.go 7KB insertDataTest.go 7KB rabbitmq.go 7KB schema.go 7KB toserver.go 7KB mongodb.go 6KB binlog_table_filter.go 6KB data_check.go 6KB input_min_position.go 6KB input_customer_json_data_test.go 6KB redis.go 6KB input.go 6KB redis_test.go 6KB normal_sync.go 6KB json.go 6KB schema.go 6KB flow_get.go 6KB channel.go 5KB input.go 5KB binlog_query.go 5KB customer_json.go 5KB user.go 5KB json_test.go 5KB decimal_test.go 5KB input_customer_json_data.go 5KB共 478 条
- 1
- 2
- 3
- 4
- 5
资源评论
Java程序员-张凯
- 粉丝: 1w+
- 资源: 7361
下载权益
C知道特权
VIP文章
课程特权
VIP享7折，此内容立减5.97元 开通VIP
最新资源
资源上传下载、课程学习等过程中有任何疑问或建议，欢迎提出宝贵意见哦~我们会及时处理！
点击此处反馈
