README (README.md)
SUI Mobile(MSUI)
轻量的UI库
SUI Mobile 是阿里巴巴国际UED前端团队出品的移动端 __UI库__。
没有重复造轮子。主要借鉴 __Framework7__ 的形态并以此为基础,参考Ratchet、Ionic、Onsen各种不同的思路,强化功能,精简体积,并提供国内最稳定快速的CDN支持。此外还定制增强了一些工具类开源库。
它的特点是非常轻量,并且能很好兼容 iOS 6.0+ 和 Android 4.0+ 的设备。
更多信息请前往 官网
问题反馈
首先在官网FAQ页看下常见疑问里有没有你的问题。
其次在issue里搜索一下你的问题关键字,可能之前已经有人遇到并解决了,可以节省大量时间精力。
明确的问题更__推荐__直接提issue反馈。
也可以在旺旺群 1278550944 交流
Issue 注意
考虑到移动端的特性,请一定写明 __系统、机型、浏览器的型号和版本__
Pull Request
强烈欢迎大家提交PR一起完善,共建社区。简明开发文档在 develop.md
Config.Yml (_config.yml)
Meta data
name: MSUI
authors: 阿里巴巴国际UED前端
favicon: http://gtms04.alicdn.com/tps/i4/TB17MaDGpXXXXb7apXXAz6UFXXX-16-16.png
version: 0.6.2
Dependencies
highlighter: rouge
Permalinks
permalink: pretty
Server
source: docs
host: 0.0.0.0
port: 4000
CONTRIBUTING (CONTRIBUTING.md)
Contributing to Ratchet
Types of issues
The GitHub issue tracker should only be used for one of the
following:
- Bugs — when a feature of the project has been _identified as
broken_.
- Feature requests — when you ask for a _new feature_ to be added to a
project.
- Contribution enquiries — when you want to discuss whether a _new
feature_ or _change_ would be accepted in a project before you begin
development work on it.
These are some things that don't belong in the issue tracker:
- Please avoid personal support requests. We cannot
provide personal support for implementation issues. The best place for help
is generally going to be StackOverflow, Twitter, IRC, etc.
- Please avoid derailing issues. Keep the discussion on topic and respect
the opinions of others.
Bugs
A bug is a _demonstrable problem_ that is caused by the code in the
repository.
If you've come across a problem with the code and you're letting us know about
it, _thank you_. We appreciate your time and the effort you're making to help
improve the code for everyone else!
Please read the following guidelines for reporting bugs:
- Use the GitHub issue search — check if the issue has already been
reported. If it has been, please comment on the existing issue.
- Check if the issue has been fixed — the latest
masteror
development branch may already contain a fix.
- Isolate the demonstrable problem — make sure that the code in the
project's repository is _definitely_ responsible for the issue. Create a
reduced test case - an
extremely simple and immediately viewable example of the issue.
- Include a live example — provide a link to your reduced test case
when appropriate (e.g. if the issue is related to front-end technologies).
Please use jsFiddle to host examples.
Please try to be as detailed as possible in your report too. What is your
environment? What steps will reproduce the issue? What browser(s) and OS
experience the problem? What would you expect to be the outcome? All these
details will help me and others to assess and fix any potential bugs.
Example of a good bug report
Short and descriptive title
A summary of the issue and the browser/OS environment in which it occurs. If
suitable, include the steps required to reproduce the bug.
1. This is the first step
2. This is the second step
3. Further steps, etc.
`` - a link to the reduced test case
Any other information you want to share that is relevant to the issue being
reported. This might include the lines of code that you have identified as
causing the bug, and potential solutions (and your opinions on their
merits).
A good bug report shouldn't leave us needing to chase you up to get further
information that is required to assess or fix the bug.
Feature requests
Feature requests are welcome! Please provide links to examples or articles that
help to illustrate the specifics of a feature you're requesting. The more
detail, the better. It will help us to decide whether the feature is something I
agree should become part of the project.
Contribution enquiries
Contribution enquiries should take place before any significant pull request,
otherwise you risk spending a lot of time working on something that we might not
want to pull into the repository.
In this regard, some contribution enquires may be feature requests that you
would like to have a go at implementing yourself if they are wanted. Other
enquiries might revolve around refactoring code or porting a project to
different languages.
Pull requests
Good pull requests - patches, improvements, new features - are a fantastic
help.
If you've spotted any small, obvious errors and want to help out by patching it,
that will be much appreciated.
If your contribution involves a significant amount of work or substantial
changes to any part of the project, please open a "contribution enquiry" issue
first to check that the work is wanted or matches the goals of the project.
All pull requests should remain focused in scope and avoid containing unrelated
commits.
Please follow this process; it's the best way to get your work included in the
project:
- Fork the project.
- Clone your fork (`git clone
[email protected]:<your-username>/<repo-name>.git`).
- Add an
upstreamremote (`git remote add upstream
git://github.com//<repo-name>.git`).
- Get the latest changes from upstream (e.g. `git pull upstream
<dev-branch>`).
- Create a new topic branch to contain your feature, change, or fix (`git
checkout -b <topic-branch-name>`).
- Make sure that your changes adhere to the current coding conventions used
throughout the project - indentation, accurate comments, etc.
- Commit your changes in logical chunks; use git's [interactive
rebase](https://help.github.com/articles/interactive-rebase) feature to tidy
up your commits before making them public. Please adhere to these git commit
message guidelines
or your pull request is unlikely be merged into the main project.
- Locally merge (or rebase) the upstream branch into your topic branch.
- Push your topic branch up to your fork (`git push origin
<topic-branch-name>`).
- Open a Pull Request with a
clear title and description. Please mention which browsers you tested in.
If you have any other questions about contributing, please feel free to contact
us.
Don't edit files in dist/. You should edit files in sass/ and js/.
Special thanks to @necolas
For writing the original issue-guidelines from which these were adapted.
Package.Json (package.json)
{
"name": "sm",
"description": "Build mobile apps with simple HTML, CSS, and JS components.",
"version": "0.6.2",
"keywords": [
"css",
"fonts",
"ios",
"android",
"mobile",
"prototype"
],
"homepage": "http://m.sui.taobao.org/",
"style": "dist/css/sm.css",
"less": "less/sm.less",
"repository": {
"type": "git",
"url": ""
},
"license": "MIT",
"scripts": {
"test": "grunt test"
},
"devDependencies": {
"grunt": "^0.4.5",
"grunt-autoprefixer": "~3.0.0",
"grunt-banner": "~0.3.1",
"grunt-cli": "^0.1.13",
"grunt-contrib-clean": "~0.6.0",
"grunt-contrib-concat": "^0.5.1",
"grunt-contrib-connect": "~0.10.1",
"grunt-contrib-copy": "~0.8.0",
"grunt-contrib-cssmin": "~0.14.0",
"grunt-contrib-jshint": "~0.11.1",
"grunt-contrib-uglify": "^0.11.0",
"grunt-contrib-watch": "~0.6.1",
"grunt-jekyll": "~0.4.2",
"load-grunt-tasks": "~3.1.0",
"time-grunt": "~1.1.0"
},
"engines": {
"node": ">=0.10.1"
},
"dependencies": {
"grunt-contrib-less": "^1.0.1",
"grunt-contrib-qunit": "^0.7.0"
}
}
Robots (docs/robots.txt)
www.robotstxt.org/
Allow crawling of all content
User-agent: *
Disallow:
Sitemap: {{ site.url }}/sitemap.xml
Data/Ratchicons.Yml (docs/_data/ratchicons.yml)
This file is generated via Grunt task. **Do not edit directly.**
See the 'build-ratchicons-data' task in Gruntfile.js.
- icon-back
- icon-bars
- icon-caret
- icon-check
- icon-close
- icon-code
- icon-compose
- icon-download
- icon-edit
- icon-forward
- icon-gear
- icon-home
- icon-info
- icon-list
- icon-more-vertical
- icon-more
- icon-pages
- icon-pause
- icon-person
- icon-play
- icon-plus
- icon-refresh
- icon-search
- icon-share
- icon-sound
- icon-sound2
- icon-sound3
- icon-sound4
- icon-star-filled
- icon-star
- icon-stop
- icon-trash
- icon-up-nav
- icon-up
- icon-right-nav
- icon-right
- icon-down-nav
- icon-down
- icon-left-nav
- icon-left
Less/.Csscomb.Json (less/.csscomb.json)
{
"always-semicolon": true,
"block-indent": 2,
"color-case": "lower",
"color-shorthand": true,
"element-case": "lower",
"eof-newline": true,
"leading-zero": false,
"remove-empty-rulesets": true,
"space-after-colon": 1,
"space-after-combinator": 1,
"space-after-declaration": "\n",
"space-after-opening-brace": "\n",
"space-before-closing-brace": "\n",
"space-before-colon": 0,
"space-before-combinator": 1,
"space-before-opening-brace": 1,
"strip-spaces": true,
"unitless-zero": true,
"vendor-prefix-align": true,
"sort-order": [
[
"position",
"top",
"right",
"bottom",
"left",
"z-index",
"display",
"float",
"width",
"min-width",
"max-width",
"height",
"min-height",
"max-height",
"-webkit-box-sizing",
"-moz-box-sizing",
"box-sizing",
"-webkit-appearance",
"padding",
"padding-top",
"padding-right",
"padding-bottom",
"padding-left",
"margin",
"margin-top",
"margin-right",
"margin-bottom",
"margin-left",
"overflow",
"overflow-x",
"overflow-y",
"-webkit-overflow-scrolling",
"-ms-overflow-x",
"-ms-overflow-y",
"-ms-overflow-style",
"clip",
"clear",
"font",
"font-family",
"font-size",
"font-style",
"font-weight",
"font-variant",
"font-size-adjust",
"font-stretch",
"font-effect",
"font-emphasize",
"font-emphasize-position",
"font-emphasize-style",
"font-smooth",
"-webkit-hyphens",
"-moz-hyphens",
"hyphens",
"line-height",
"color",
"text-align",
"-webkit-text-align-last",
"-moz-text-align-last",
"-ms-text-align-last",
"text-align-last",
"text-emphasis",
"text-emphasis-color",
"text-emphasis-style",
"text-emphasis-position",
"text-decoration",
"text-indent",
"text-justify",
"text-outline",
"-ms-text-overflow",
"text-overflow",
"text-overflow-ellipsis",
"text-overflow-mode",
"text-shadow",
"text-transform",
"text-wrap",
"-webkit-text-size-adjust",
"-ms-text-size-adjust",
"letter-spacing",
"-ms-word-break",
"word-break",
"word-spacing",
"-ms-word-wrap",
"word-wrap",
"-moz-tab-size",
"-o-tab-size",
"tab-size",
"white-space",
"vertical-align",
"list-style",
"list-style-position",
"list-style-type",
"list-style-image",
"pointer-events",
"cursor",
"visibility",
"zoom",
"flex-direction",
"flex-order",
"flex-pack",
"flex-align",
"table-layout",
"empty-cells",
"caption-side",
"border-spacing",
"border-collapse",
"content",
"quotes",
"counter-reset",
"counter-increment",
"resize",
"-webkit-user-select",
"-moz-user-select",
"-ms-user-select",
"-o-user-select",
"user-select",
"nav-index",
"nav-up",
"nav-right",
"nav-down",
"nav-left",
"background",
"background-color",
"background-image",
"-ms-filter:\\'progid:DXImageTransform.Microsoft.gradient",
"filter:progid:DXImageTransform.Microsoft.gradient",
"filter:progid:DXImageTransform.Microsoft.AlphaImageLoader",
"filter",
"background-repeat",
"background-attachment",
"background-position",
"background-position-x",
"background-position-y",
"-webkit-background-clip",
"-moz-background-clip",
"background-clip",
"background-origin",
"-webkit-background-size",
"-moz-background-size",
"-o-background-size",
"background-size",
"border",
"border-color",
"border-style",
"border-width",
"border-top",
"border-top-color",
"border-top-style",
"border-top-width",
"border-right",
"border-right-color",
"border-right-style",
"border-right-width",
"border-bottom",
"border-bottom-color",
"border-bottom-style",
"border-bottom-width",
"border-left",
"border-left-color",
"border-left-style",
"border-left-width",
"border-radius",
"border-top-left-radius",
"border-top-right-radius",
"border-bottom-right-radius",
"border-bottom-left-radius",
"-webkit-border-image",
"-moz-border-image",
"-o-border-image",
"border-image",
"-webkit-border-image-source",
"-moz-border-image-source",
"-o-border-image-source",
"border-image-source",
"-webkit-border-image-slice",
"-moz-border-image-slice",
"-o-border-image-slice",
"border-image-slice",
"-webkit-border-image-width",
"-moz-border-image-width",
"-o-border-image-width",
"border-image-width",
"-webkit-border-image-outset",
"-moz-border-image-outset",
"-o-border-image-outset",
"border-image-outset",
"-webkit-border-image-repeat",
"-moz-border-image-repeat",
"-o-border-image-repeat",
"border-image-repeat",
"outline",
"outline-width",
"outline-style",
"outline-color",
"outline-offset",
"-webkit-box-shadow",
"-moz-box-shadow",
"box-shadow",
"filter:progid:DXImageTransform.Microsoft.Alpha(Opacity",
"-ms-filter:\\'progid:DXImageTransform.Microsoft.Alpha",
"opacity",
"-ms-interpolation-mode",
"-webkit-transition",
"-moz-transition",
"-ms-transition",
"-o-transition",
"transition",
"-webkit-transition-delay",
"-moz-transition-delay",
"-ms-transition-delay",
"-o-transition-delay",
"transition-delay",
"-webkit-transition-timing-function",
"-moz-transition-timing-function",
"-ms-transition-timing-function",
"-o-transition-timing-function",
"transition-timing-function",
"-webkit-transition-duration",
"-moz-transition-duration",
"-ms-transition-duration",
"-o-transition-duration",
"transition-duration",
"-webkit-transition-property",
"-moz-transition-property",
"-ms-transition-property",
"-o-transition-property",
"transition-property",
"-webkit-transform",
"-moz-transform",
"-ms-transform",
"-o-transform",
"transform",
"-webkit-transform-origin",
"-moz-transform-origin",
"-ms-transform-origin",
"-o-transform-origin",
"transform-origin",
"-webkit-animation",
"-moz-animation",
"-ms-animation",
"-o-animation",
"animation",
"-webkit-animation-name",
"-moz-animation-name",
"-ms-animation-name",
"-o-animation-name",
"animation-name",
"-webkit-animation-duration",
"-moz-animation-duration",
"-ms-animation-duration",
"-o-animation-duration",
"animation-duration",
"-webkit-animation-play-state",
"-moz-animation-play-state",
"-ms-animation-play-state",
"-o-animation-play-state",
"animation-play-state",
"-webkit-animation-timing-function",
"-moz-animation-timing-function",
"-ms-animation-timing-function",
"-o-animation-timing-function",
"animation-timing-function",
"-webkit-animation-delay",
"-moz-animation-delay",
"-ms-animation-delay",
"-o-animation-delay",
"animation-delay",
"-webkit-animation-iteration-count",
"-moz-animation-iteration-count",
"-ms-animation-iteration-count",
"-o-animation-iteration-count",
"animation-iteration-count",
"-webkit-animation-direction",
"-moz-animation-direction",
"-ms-animation-direction",
"-o-animation-direction",
"animation-direction"
]
]
}