config(EJ2-6101): version 16.1.24 released

Author: ROOT\jesusarockias

README.md

@@ -1,33 +1,105 @@
+# JavaScript Sample Browser
 
+## Adding New Sample
 
-## Installing
+Create your new folder in 'src' location and name the folder as control name. Example: “button” or "list-view".
 
-To install all dependent packages, use the below command
+Add your sample order in the `src/common/sampleOrder.json` with corresponding category.
+
+**Note:** Do not use whitespace at any cause in the folder’s name. Use “-” instead of space.
+
+
+### Configure the folder and sample
+
+Create the “sample.json” file inside of your control folder.  Create your sample html and js file in same folder also the html and js files should have the same names.
+
+**Note:** Do not use whitespace at any cause in the file’s name. Use “-” instead of space.
+
+
+### Configure Sample JSON
+
+Configure your sample json file as like below code snippet.
 
 ```
-npm install
+{
+    "name": "Grid",
+    "directory": "grid",
+    "category": "Grid",
+    "samples": [
+        { "url": "localdata", "name": "Local Data", "category": "Data Binding" },
+        { "url": "remotedata", "name": "Remote Data", "category": "Data Binding" },
+        { "url": "autowrap", "name": "AutoWrap Column Cells", "category": "Columns" },
+        { "url": "showhide", "name": "Show or Hide Column", "category": "Columns" }
+    ],
+    "dataSourcePath": "src/grid/datasource.js"
+}
 ```
+**Note:** To exculde a sample in the device you need to set `hideOnDevice` as true for the sample json file.
+
+**Fields Description:**
+
+* _name :_ It can be any string that you want to show a component name.
+
+* _directory :_ Specifies that your sample's directory name.
+
+* _category :_ Specify that your sample comes under which category.
+
+* _dataSourcePath :_ Specify that your data source file Path (Optional).
+
+* _samples :_ Specify array of samples in your control.
+
+* _samples.url :_ specifies the file name without extension.
+
+* _samples.name :_ It can be any string that you want to show a sample name.
+
+* _samples.category :_ Specify that your sample comes under which category.
 
-## Building
 
-To compile the source files, use the below command
+## Adding datasource components
+
+To add datasource file for the component, you need to include the `dataSourcePath` option which need to map the datasource file path in the component's sample.json. 
+
+refer the below link for config
+
+https://gitlab.syncfusion.com/essential-studio/ej2-javascript-samples/blob/7a32bea49aca215fdef1fe432e4135fa07ff3c83/src/grid/sample.json#L9 
+
+The sample datasource file need to store the json in window variable.
+
+Each component's datasource window variable name must be unique.
+
+For example datasource for grid must be stored as `window.gridData`.
+
+Refer the below below datasource file for further reference
+
+https://gitlab.syncfusion.com/essential-studio/ej2-javascript-samples/blob/19761f5590b4af5b2ea1cb90bed33d8dfa496de9/src/grid/datasource.js
+
+**Note:** Each component should include one datasource file only.
+
+## Run the sample browser
+
+We can run the sample browser with two commands
+
+1. **gulp _serve_** – run the sample browser alone.
+2. **gulp _watch_** – run the sample browser and monitor typescript as well. This will help at development time. If any changes detect means it will automatically compile and browser will reloaded.
 
 ```
-npm run build
+gulp serve
 ```
 
-## Testing
 
-To test the source files, use the below command
+**Access URLs:**
+
+Local URL is works only in your machine.
 
 ```
-npm run test
+http://localhost:3000
 ```
 
-## Running
-
-To run the samples, use the below command
+External URL is works in all locally connected LAN. (You can use to see sample browser in mobile).
 
 ```
-npm run serve
-```
+http://your-ip-address:3000
+```
+
+**Note:** Here, The mentioned IP is your local machine IP Address.
+

config.json

@@ -0,0 +1,9 @@
+{
+    "htmllint": ["./src/**/*.html"],
+    "json": ["./**/*.json"],
+    "samplejson": ["./src/**/*sample.json"],
+    "dedupe": ["./src/**/*.js"],
+    "watchSample": ["./src/**/*.js"],
+    "jshint": ["./src/**/*.js", "!./src/**/*.min.js", "!./src/common/samplelist.js", "!./src/common/api-table-generator.js","!./src/common/search-index.js"],
+    "github": ["./src/**/*.{html,ts,json}", "./styles{,/**}", "./src/**/images{,/**}", "./src/common/lib{,/**}", "./src/common/cldr-data{,/**}", "./src/showcase{,/**}", "!./src/showcase/**/!(webpack.config)*.{js,json}", "!./styles/**/!(index)*.css", "./spec/**/*.ts", "./*.html", "./favicon.ico", "karma.conf.js", "package.json", "test-main.js", "tsconfig.json", "webpack.config.js", "!./googlec03dd4bc003151bc.html", "license"]
+}

gulpfile.js

@@ -362,4 +362,4 @@ gulp.task('js-hint', function () {
         .pipe(jshint())
         .pipe(jshint.reporter('default'))
         .pipe(jshint.reporter('fail'));
-});
+});