Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Enyo 2 Sampler

Update sampler submodules to 2.4.0 (fixes previous commit,

which was off by one commit due to missing git pull in release script).
Enyo-DCO-1.1-Signed-Off-By: Kevin Schaaf (kevin.schaaf@lge.com)
latest commit d11c5b43d5
Kevin Schaaf kevinpschaaf authored
Octocat-spinner-32 assets Remove samples for moon.GridList, moon.List
Octocat-spinner-32 enyo @ 4e7164b Update sampler submodules to 2.4.0 (fixes previous commit,
Octocat-spinner-32 lib Update sampler submodules to 2.4.0 (fixes previous commit,
Octocat-spinner-32 projects Add files needed for webos build & update appinfo.json
Octocat-spinner-32 source Simplify app code for source viewer
Octocat-spinner-32 tools Update deploy scripts and top-level package to match latest bootplate…
Octocat-spinner-32 .gitignore Ignore generated files
Octocat-spinner-32 .gitmodules Update submodules for 2.3.0-rc.6, remove g11n
Octocat-spinner-32 .htaccess Enable CORS for sampler to allow jsFiddle.net to load g11n data
Octocat-spinner-32 .jshintignore Add .jshintrc and .jshintignore files for sampler
Octocat-spinner-32 .jshintrc Add .jshintrc and .jshintignore files for sampler
Octocat-spinner-32 .travis.yml Add .jshintrc and .jshintignore files for sampler
Octocat-spinner-32 LICENSE-2.0.txt Add LICENSE-2.0.txt to make sure license is clear at the repo level f…
Octocat-spinner-32 README.md Update README.md with copyright and license info
Octocat-spinner-32 consoleShim.js Add .jshintrc and .jshintignore files for sampler
Octocat-spinner-32 debug.html ENYO-1837: turn off phone number detection and translation via meta t…
Octocat-spinner-32 disableEnyoDom.js Add .jshintrc and .jshintignore files for sampler
Octocat-spinner-32 icon.png add icon.png
Octocat-spinner-32 iframe.html Add iframed-container for debug.html to help figure out IE8 iframe is…
Octocat-spinner-32 index.html ENYO-1837: turn off phone number detection and translation via meta t…
Octocat-spinner-32 manifest.webapp Add manifest file for Firefox OS
Octocat-spinner-32 package.js Update deploy scripts and top-level package to match latest bootplate…
Octocat-spinner-32 speedTest.html Remove flex from speedTest.js
Octocat-spinner-32 speedTest.js Remove flex from speedTest.js
Octocat-spinner-32 speedTestDebug.html Remove flex from speedTest.js
README.md

Enyo 2 Sampler

A cross-platform application for viewing Enyo 2 samples from all its various libraries.

For the most recent released version, see the Enyo JS website. The latest nightly build is also available at http://nightly.enyojs.com/latest/sampler/debug.html.

The app allows navigation through each library's samples. Each sample is designed to be usable across all form factors, as a kind that can be rendered within the Sampler app, as well as standalone via the accompanying .html file.

You can inspect the current sample through the console via window.sample.

Since the app AJAX's in the JavaScript and CSS source files for the viewer, a few simple conventions must be followed to add new samples to the app:

  • The assets/manifest.json file defines the left-hand navigation hierarchy of the app:
    • An entry with a samples array defines a nested menu.
    • An entry with a path string defines a sample at the path's location (omit the .js from the filename)
    • Optionally, a css string defines the base filename of a shared CSS file instead of defaulting to use a CSS file with the same name as the .js file.
  • A sample must consist of one .js file containing a top-level kind of the same name as the file. For example ButtonSample.js should contain (at least) a ButtonSample kind, which is the kind rendered into the right-hand panel of the app.
  • By default, samples should define their css in a file with the same name as the kind (for example, ButtonSample.css). However, by specifying the optional css parameter in the manifest, more than one smaple may share the same CSS file.
  • Using this scheme, more than one sample .js file may be situated in the same folder, where they all share a sample.css file.
  • When deploying the app, change the sourcePath variable in assets/manifest.json to point to a root directory containing un-minified versions of the enyo and lib directories (containing at least the samples).

URL Parameters

The sampler can take additional parameters on the URL, added as arguments after a '?' character.

addSamples=[,...]

This provides one or more additional paths from which to load samples. The path should be to a manifest.json hosted in the new collection's folder. Sampler will also try to load a package.js from the same folder to pull in the sample source. You can use this when testing a library to load its samples into the system without having to add them to the sampler source. These paths are saved into local storage so they don't have to be referenced in the future.

sourcePath=

This sets a path to load sample source from instead of the default manifest. This paths is saved into local storage so it doesn't have to be referenced in the future.

extras=1

This enables test mode, where you can go through each sample one-by-one. It also lets you modify the addSamples and sourcePath directly via a settings GUI and gives access to BrowserScope test recording.

reset=1

This clears previous paramameters stored in local storage.

Benchmarking

There are a couple of alternate index.html files that will load all of the standard samples and run them as a JavaScript benchmark. speedTest.html will load the minified source, while speedTestDebug.html loads the full source from the trees. Output of benchmark results goes to the debug console.

Copyright and License Information

Unless otherwise specified, all content, including all source code files and documentation files in this repository are:

Copyright (c) 2012-2014 LG Electronics

Unless otherwise specified or set forth in the NOTICE file, all content, including all source code files and documentation files in this repository are: Licensed under the Apache License, Version 2.0 (the "License"); you may not use this content 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.

Something went wrong with that request. Please try again.