1- ## Widgets [ ![ Build Status] ( https://travis-ci.org/surveyjs/widgets.svg?branch=master )] ( https://travis-ci.org/surveyjs/widgets ) [ ![ Software License] ( https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat )] ( LICENSE )
2-
3- - select2: [ site] ( https://select2.org/ ) , [ repo] ( https://github.com/select2/select2 ) , license: MIT
4-
5- - select2tagbox: [ site] ( https://select2.org/ ) , [ repo] ( https://github.com/select2/select2 ) , license: MIT
6-
7- - icheck: [ site] ( http://icheck.fronteed.com/ ) , [ repo] ( https://github.com/fronteed/iCheck/ ) , license: MIT
8-
9- - imagepicker: [ site] ( https://rvera.github.io/image-picker/ ) , [ repo] ( https://github.com/rvera/image-picker ) , license: MIT
10-
11- - inputmask: [ site] ( http://robinherbots.github.io/Inputmask/ ) , [ repo] ( https://github.com/RobinHerbots/Inputmask ) , license: MIT
12-
13- - jquerybarrating: [ site] ( http://antenna.io/demo/jquery-bar-rating/examples/ ) , [ repo] ( https://github.com/antennaio/jquery-bar-rating ) , license: MIT
14-
15- - jqueryuidatepicker: [ site] ( https://jqueryui.com/datepicker/ ) , [ repo] ( https://github.com/jquery/jquery-ui ) , license: https://github.com/jquery/jquery-ui/blob/master/LICENSE.txt
16-
17- - nouislider: [ site] ( https://refreshless.com/nouislider/ ) , [ repo] ( https://github.com/leongersen/noUiSlider ) , license: https://github.com/leongersen/noUiSlider/blob/master/LICENSE
18-
19- - signaturepad: [ site] ( http://szimek.github.io/signature_pad/ ) , [ repo] ( https://github.com/szimek/signature_pad ) , license: MIT
20-
21- - sortablejs: [ site] ( http://rubaxa.github.io/Sortable/ ) , [ repo] ( https://github.com/RubaXa/Sortable ) , license: MIT
22-
23- - ckeditor: [ site] ( https://ckeditor.com/ckeditor-4/ ) , [ repo] ( https://github.com/ckeditor/ckeditor-dev ) , license: https://github.com/ckeditor/ckeditor-dev/blob/major/LICENSE.md
24-
25- - easyautocomplete: [ site] ( http://easyautocomplete.com/ ) , [ repo] ( https://github.com/pawelczak/EasyAutocomplete ) , license: https://github.com/pawelczak/EasyAutocomplete/blob/master/LICENSE.txt
26-
27- - pretty-checkbox: [ site] ( https://lokesh-coder.github.io/pretty-checkbox/ ) , [ repo] ( https://github.com/lokesh-coder/pretty-checkbox/ ) , license: https://github.com/lokesh-coder/pretty-checkbox/blob/master/LICENSE
28-
29- - bootstrap-slider: [ site] ( http://seiyria.com/bootstrap-slider/ ) , [ repo] ( https://github.com/seiyria/bootstrap-slider ) , license: https://github.com/seiyria/bootstrap-slider/blob/master/LICENSE.md
30-
31- - recordrtc: [ site] ( http://recordrtc.org/ ) , [ repo] ( https://github.com/muaz-khan/RecordRTC ) , license [ MIT] ( http://spdx.org/licenses/MIT.html )
32-
33- ## Getting started
1+ ## Widgets [ ![ Build Status] ( https://travis-ci.org/surveyjs/widgets.svg?branch=master )] ( https://travis-ci.org/surveyjs/widgets ) [ ![ Software License] ( https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat )] ( LICENSE )
2+
3+ * select2: [ site] ( https://select2.org/ ) , [ repo] ( https://github.com/select2/select2 ) , license: MIT
4+
5+ * select2tagbox: [ site] ( https://select2.org/ ) , [ repo] ( https://github.com/select2/select2 ) , license: MIT
6+
7+ * icheck: [ site] ( http://icheck.fronteed.com/ ) , [ repo] ( https://github.com/fronteed/iCheck/ ) , license: MIT
8+
9+ * imagepicker: [ site] ( https://rvera.github.io/image-picker/ ) , [ repo] ( https://github.com/rvera/image-picker ) , license: MIT
10+
11+ * inputmask: [ site] ( http://robinherbots.github.io/Inputmask/ ) , [ repo] ( https://github.com/RobinHerbots/Inputmask ) , license: MIT
12+
13+ * jquerybarrating: [ site] ( http://antenna.io/demo/jquery-bar-rating/examples/ ) , [ repo] ( https://github.com/antennaio/jquery-bar-rating ) , license: MIT
14+
15+ * jqueryuidatepicker: [ site] ( https://jqueryui.com/datepicker/ ) , [ repo] ( https://github.com/jquery/jquery-ui ) , license: https://github.com/jquery/jquery-ui/blob/master/LICENSE.txt
16+
17+ * nouislider: [ site] ( https://refreshless.com/nouislider/ ) , [ repo] ( https://github.com/leongersen/noUiSlider ) , license: https://github.com/leongersen/noUiSlider/blob/master/LICENSE
18+
19+ * signaturepad: [ site] ( http://szimek.github.io/signature_pad/ ) , [ repo] ( https://github.com/szimek/signature_pad ) , license: MIT
20+
21+ * sortablejs: [ site] ( http://rubaxa.github.io/Sortable/ ) , [ repo] ( https://github.com/RubaXa/Sortable ) , license: MIT
22+
23+ * ckeditor: [ site] ( https://ckeditor.com/ckeditor-4/ ) , [ repo] ( https://github.com/ckeditor/ckeditor-dev ) , license: https://github.com/ckeditor/ckeditor-dev/blob/major/LICENSE.md
24+
25+ * easyautocomplete: [ site] ( http://easyautocomplete.com/ ) , [ repo] ( https://github.com/pawelczak/EasyAutocomplete ) , license: https://github.com/pawelczak/EasyAutocomplete/blob/master/LICENSE.txt
26+
27+ * pretty-checkbox: [ site] ( https://lokesh-coder.github.io/pretty-checkbox/ ) , [ repo] ( https://github.com/lokesh-coder/pretty-checkbox/ ) , license: https://github.com/lokesh-coder/pretty-checkbox/blob/master/LICENSE
28+
29+ * bootstrap-slider: [ site] ( http://seiyria.com/bootstrap-slider/ ) , [ repo] ( https://github.com/seiyria/bootstrap-slider ) , license: https://github.com/seiyria/bootstrap-slider/blob/master/LICENSE.md
30+
31+ * recordrtc: [ site] ( http://recordrtc.org/ ) , [ repo] ( https://github.com/muaz-khan/RecordRTC ) , license [ MIT] ( http://spdx.org/licenses/MIT.html )
32+
33+ ## Getting started
34+
3435es5 examples: https://surveyjs.io/Examples/Library/?id=custom-widget-select2-tagbox
35- es modules examples: https://stackblitz.com/edit/surveyjs-widgets-react
36+ es modules examples: https://stackblitz.com/edit/surveyjs-widgets-react
3637
3738Install the library using es5.
39+
3840```
3941<script src="https://unpkg.com/surveyjs-widgets"></script>
4042```
43+
4144Install the library using npm.
4245
4346```
@@ -49,28 +52,34 @@ https://surveyjs.azureedge.net/0.95.0/surveyjs-widgets.min.js
4952
5053You find all versions/builds in the [ surveyjs/build repo] ( https://github.com/surveyjs/builds ) .
5154
52-
5355## Building surveyjs-widgets from sources
5456
5557To build library yourself:
5658
57- 1 . ** Clone the repo from GitHub**
58- ```
59- git clone https://github.com/surveyjs/surveyjs-widgets.git
60- cd surveyjs-widgets
61- ```
59+ 1 . ** Clone the repo from GitHub**
60+
61+ ```
62+ git clone https://github.com/surveyjs/surveyjs-widgets.git
63+ cd surveyjs-widgets
64+ ```
65+
66+ 2. **Acquire build dependencies.** Make sure you have [Node.js](http://nodejs.org/) installed on your workstation. This is only needed to _build_ surveyjs from sources.
67+
68+ ```
69+ npm install
70+ ```
71+
72+ 3. **Build the library**
6273
63- 2 . ** Acquire build dependencies.** Make sure you have [ Node.js] ( http://nodejs.org/ ) installed on your workstation. This is only needed to _ build_ surveyjs from sources.
64- ```
65- npm install
66- ```
74+ ```
75+ npm run build
76+ ```
6777
68- 3 . ** Build the library**
69- ```
70- npm run build
71- ```
72- After that you should have the libraries (angular, jquery, knockout, react and vue) at 'packages' directory.
78+ After that you should have the libraries (angular, jquery, knockout, react and vue) at 'packages' directory.
7379
80+ 4. **Add your own custom widget**
81+ Please go to [this plunker](https://plnkr.co/edit/HdnYE5?p=preview) and select customwidget.js to review the code and comments
82+ The [same plunker example](https://plnkr.co/edit/fXsLf1R88WxxDFaFEnYx?p=preview), but for SurveyJS Editor/Builder
7483
7584## License
7685
0 commit comments