Semantic-Org/Module-Examples

Name: Module-Examples

Owner: Semantic Org

Description: Annotated source of Semantic UI Module Format

Created: 2015-04-27 22:04:48.0

Updated: 2017-08-27 13:14:21.0

Pushed: 2015-04-27 22:47:39.0

Homepage: http://semantic-org.github.io/Module-Examples/docs/module.html

Size: 428

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

What's Here

This is the annotated source of the standard module format used to power UI modules in Semantic UI.

You can view the annotated source online.

Standard Features

• Standardizes element lifecycle, initialize, bind events, instantiate, destroy, refresh, etc.
• Built in debug tools designed to make developer comments appear as traces during execution
• Built in performance logging that shows diffed time in milliseconds between debug logs
• Designed so that css selectors, metadata, regular expresions, even error messages are passed through as settings and user-editable

Advanced Features

Method Lookup

Method invocation automatically converts sentence case to camelCase or nested object during method lookup

component').component('set text', 'Foobar');

Internally matches against methods

 {
xt: function(text) {
 // do something

As well as

ext: function(Text) {
 do something

Mutation Observers

Elements use DOM Mutation Observers to allow refreshing cached values after changes

MutationObserver' in window) {
server = new MutationObserver(function(mutations) {
module.debug('Element updated refreshing selectors');
module.refresh();
;
server.observe(element, {
childList : true,
subtree   : true
;
dule.debug('Setting up mutation observer', observer);

Building Docs

 get docco
install -g docco
 build
o src/*.js --css src/css/docco