naver / jindojs-jmc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This project is no longer maintained since 2017. Please use alternatives libraries as 'jQuery' and 'egjs' instead of Jindo and JC/JMC. If you need to migrate, check out migration documents(jQuery/JMC) listed as below.

JMC - Jindo Mobile Component

Build Status

What is JMC?

JMC is a framework that make easier to develop mobile web UI. JMC provide UI components like scroll, flicking, etc..

JMC is the main JavaScript Mobile Component used for developing most of NAVER's web products.

JMC is a part of JindoJS family product

JindoJS consists with : Jindo, Jindo Component and Jindo Mobile Component

JMC Features

  • Support cross platform and browsing in mobile environment
  • Provide fast loading speed and optimal performance
  • It makes to manage separately presentational markup and logic programming code
  • Components can be extended through a custom event

How to install?

bower install jindojs-jmc

Modules

  • The below list are modules that are used frequently.

  • For complete list and it's API, please visit :

  • http://jindo.nhncorp.com/docs/jindo-mobile/archive/latest/doc/internal/index.html

  • m: Basic name space of Jindo Mobile Component, as well as being a static object.

  • *m.Flicking: Component that shows multiple contents areas by various effects(XXX) left/right, up/down through user’s touch movements.

  • m.Scroll: Component that can be scrolled by touching inside the page’s fixed area

  • m.IndexScroll: Component that can touch inside the page’s fixed area and scroll, and also has an index display function and scroll bar.

  • m.FloatingLayer: Component where a layer is floating in a specific position on the screen, even if a scroll is activated.

  • m.MoreContentButton: Component that dynamically adds the number of lists that are designated when clicking the View More button.

  • m.PageNavigation: Component that expresses multiple items in a page format

  • m.ScrollEnd: Component that shows where the scroll ends

  • m.Touch: Component that analyzes actions, including scroll and tap, by analyzing user’s touch movement in the base layers.

How to build

Clone a copy of JMC from git repo by running:

$ git clone https://github.com/naver/jindojs-jmc.git

Enter the jindojs-jmc directory and make sure have all the necessary dependencies :

$ cd jindojs-jmc && npm install

Run the build script:

$ grunt

The result of your build, will be found in the 'dist/' subdirectory with the minified version and API document.

Running the Unit Tests

Make sure you have the necessary dependencies:

$ npm install

Start grunt 'test:*' task:

$ grunt test:*

if you want to test a specific component, put the module's name as a parameter of the test. Here are some example that you might consider.

$ grunt test:SlideFlicking  #test "jindo.m.SlideFlicking"
$ grunt test:m  #test "jindo.m"
$ grunt test:Touch  #test "jindo.m.Touch"

Issues

If you find a bug, please report us via the GitHub issues page.
https://github.com/naver/jindojs-jmc/issues

License

Licensed under LGPL v2:
https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html

Analytics

About

License:Other


Languages

Language:HTML 66.7%Language:JavaScript 30.8%Language:CSS 2.4%