phoenix-ui
Version:
future team ui for app with react
1,208 lines (648 loc) • 33.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.0, minimal-ui" />
<title>Button - phoenix-ui</title>
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/vendor/bootstrap/css/bootstrap.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
</head>
<body class="yui3-smart" _assetsPath="../assets">
<nav class="navbar navbar-inverse navbar-fixed-top custom-navbar" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand mainlogo" href="">
<img alt="phoenix-ui" src="../assets/css/logo.png" title="phoenix-ui">
phoenix-ui
</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">主页</a>
</li>
</ul>
<div class="navbar-form navbar-right filterAPi" autocomplete="off">
<input type="text" id='txtSearchAPI' class="form-control search-query" placeholder="Search for API" />
<ul id="filterList" class="filterItems dropdown-menu" role="menu"></ul>
</div>
</div>
</div>
</nav>
<div id="sidebar">
<h3>模块/类</h3>
<div id="api-tabview-filter">
<input id='txtSearch' type="search" class="form-control" placeholder="Type to filter Modules/Classes">
</div>
<dl id="sidebar_list">
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/基础组件.html">基础组件</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/Button.html">Button</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/ButtonGroup.html">ButtonGroup</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Star.html">Star</a>
<ul>
</ul>
</li>
</ul>
</dd>
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/布局组件.html">布局组件</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/Row.html">Row</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/TableView.html">TableView</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Col.html">Col</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Grid.html">Grid</a>
<ul>
</ul>
</li>
</ul>
</dd>
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/弹出框组件.html">弹出框组件</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/Alert.html">Alert</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Dialog.html">Dialog</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Prompt.html">Prompt</a>
<ul>
</ul>
</li>
</ul>
</dd>
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/提示组件.html">提示组件</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/Popover.html">Popover</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Whisper.html">Whisper</a>
<ul>
</ul>
</li>
</ul>
</dd>
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/操作类组件.html">操作类组件</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/ImageList.html">ImageList</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/LoadingList.html">LoadingList</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Popup.html">Popup</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Slider.html">Slider</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Steps.html">Steps</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Toast.html">Toast</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Accordion.html">Accordion</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Swipe.html">Swipe</a>
<ul>
</ul>
</li>
</ul>
</dd>
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/标签组件.html">标签组件</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/Icon.html">Icon</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Badge.html">Badge</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Label.html">Label</a>
<ul>
</ul>
</li>
</ul>
</dd>
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/菜单组件.html">菜单组件</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/Menu.html">Menu</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/MenuBody.html">MenuBody</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/MenuHeader.html">MenuHeader</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/MenuItem.html">MenuItem</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/MenuList.html">MenuList</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/MenuNav.html">MenuNav</a>
<ul>
</ul>
</li>
</ul>
</dd>
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/表单组件.html">表单组件</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/Input.html">Input</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Switch.html">Switch</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/FormGroup.html">FormGroup</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/TextArea.html">TextArea</a>
<ul>
</ul>
</li>
</ul>
</dd>
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/辅助组件.html">辅助组件</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/Drag.html">Drag</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Animate.html">Animate</a>
<ul>
</ul>
</li>
</ul>
</dd>
<dt>
<span class="glyphicon glyphicon-minus"></span>
<a href="../modules/选项卡.html">选项卡</a>
</dt>
<dd>
<ul>
<li>
<a href="../classes/Tab.html">Tab</a>
<ul>
</ul>
</li>
<li>
<a href="../classes/Tabset.html">Tabset</a>
<ul>
</ul>
</li>
</ul>
</dd>
</dl>
<div class="icon-sidebar-btn icon-sidebar-btn-open"><span class="glyphicon glyphicon-chevron-left"></span>收起</div>
</div>
<div class="stdoc-content">
<div class="apidocs">
<div id="docs-main">
<div class="content">
<div class="page-header">
<h1>Button</h1>
</div>
<div class="well well-small sign-left3">
<div class="stdoc-code"><p>按钮组件<br/></p>
<ul>
<li>按钮组件提供所有properties中内置的颜色及字体大小样式供选择。</li>
<li>也可以自定义行内样式和className名字定义UI展示。</li>
<li>通过phSize设置大小, 可选sm、md、lg。</li>
<li>通过phStyle选择按钮颜色，可选primary、info、error、warning、danger、link、gray、success。</li>
<li>支持disabled, active属性定义。</li>
</ul>
<p>主要属性和接口：</p>
<ul>
<li>phSize:按钮大小, 默认sm <br/>
如: <code><Button phSize="lg">button</Button></code></li>
<li>phStyle:按钮颜色, 默认primary <br/>
如: <code><Button phStyle="info">button</Button></code></li>
<li>block:是否块级显示，默认false <br/>
如: <code><Button block>button</Button></code></li>
</ul>
</div>
</div>
<div class="well well-small sign-left2 container-fluid" id="classesItems">
<div class="row">
<div class="index-section methods col-sm-4">
<h3>方法</h3>
</div>
<div class="index-section properties col-sm-4">
<h3>属性</h3>
<ul class="index-list properties extends">
<li class="index-item property">
<a href="#" data-tabid="#property" data-anchor="#property_active" data-tablink="active">active</a>
</li>
<li class="index-item property">
<a href="#" data-tabid="#property" data-anchor="#property_block" data-tablink="block">block</a>
</li>
<li class="index-item property">
<a href="#" data-tabid="#property" data-anchor="#property_classPrefix" data-tablink="classPrefix">classPrefix</a>
</li>
<li class="index-item property">
<a href="#" data-tabid="#property" data-anchor="#property_componentTag" data-tablink="componentTag">componentTag</a>
</li>
<li class="index-item property">
<a href="#" data-tabid="#property" data-anchor="#property_disabled" data-tablink="disabled">disabled</a>
</li>
<li class="index-item property">
<a href="#" data-tabid="#property" data-anchor="#property_hollow" data-tablink="hollow">hollow</a>
</li>
<li class="index-item property">
<a href="#" data-tabid="#property" data-anchor="#property_phSize" data-tablink="phSize">phSize</a>
</li>
<li class="index-item property">
<a href="#" data-tabid="#property" data-anchor="#property_phStyle" data-tablink="phStyle">phStyle</a>
</li>
<li class="index-item property">
<a href="#" data-tabid="#property" data-anchor="#property_radius" data-tablink="radius">radius</a>
</li>
</ul>
</div>
<div class="index-section events col-sm-4">
<h3>事件</h3>
</div>
</div>
</div>
<div class="">
<ul id="itemTab" class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#class">详情</a></li>
<li class=""><a data-toggle="tab" href="#property">属性</a></li>
</ul>
<div class="tab-content">
<div id="class" class="tab-pane active">
<div class="well well-small classDetail sign-left1">
<div class="extends">
Extends Component
</div>
<div class="foundat">
Defined in: <a href="../files/src_Button.js.html#l6"><code>src/Button.js:6</code></a>
</div>
Module: <a href="../modules/基础组件.html">基础组件</a>
<p>Available since 0.1.0</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Button" class="method item">
<h3 class="name">Button</h3>
<code>
Button
<span class="paren">()</span>
</code>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l6"><code>src/Button.js:6</code></a>
</p>
<p>Available since 0.1.0</p>
</div>
<div class="description well well-small sign-left3">
</div>
<div class="example app-example">
<h4>Example:</h4>
<ul class="nav nav-tabs example-list">
<li role="presentation" class="active" data-demo="https://future-team.github.io/phoenix-ui/examples/index.html#/button" _no='0'> <a>展示</a></li>
</ul>
<div class="example-content showdemo ">
<div class="stdoc-code"><pre class="code prettyprint"><code>import React, { Component } from "react";
import {Button} from "phoenix-ui";
import Code from "./code/code";
export default class button extends Component{
render(){
return(
<div>
<h2 className="comp-title">Button</h2>
<h3 className="comp-type">phSize(默认sm) 按钮大小</h3>
<div className="content">
<Button>默认sm</Button>
<Button phSize="md">md</Button>
<Button phSize="lg">lg</Button>
</div>
<Code target="button-phsize" />
<h3 className="comp-type">phStyle(默认primary) 按钮颜色</h3>
<div className="content">
<Button>默认Primary</Button>
<Button phStyle="info">Info</Button>
<Button phStyle="success">Success</Button>
<Button phStyle="error">Error</Button>
<Button phStyle="danger">Danger</Button>
<Button phStyle="warning">Warning</Button>
<Button phStyle="gray">Gray</Button>
<Button phStyle="link">Link</Button>
</div>
<Code target="button-phstyle" />
<h3 className="comp-type">hollow属性</h3>
<div className="content">
<Button hollow>hollow</Button>
</div>
<Code target="button-phstyle" />
<h3 className="comp-type">block属性</h3>
<div className="content">
<Button block>block</Button>
</div>
<Code target="button-block" />
<h3 className="comp-type">disabled属性</h3>
<div className="content">
<Button disabled>disabled</Button>
</div>
<Code target="button-disabled" />
<h3 className="comp-type">active属性</h3>
<div className="content">
<Button active>active</Button>
</div>
<Code target="button-active" />
<h3 className="comp-type">phIcon属性</h3>
<div className="content">
<Button phIcon="search">phIcon</Button>
</div>
<Code target="button-phicon" />
</div>
);
}
}</code></pre>
</div>
</div>
<div class="btn-method-box">
<button class="btn btn-info btn-viewDemo" type="button">查看示例</button>
<button class="btn btn-info btn-editDemo" type="button">编辑代码</button>
</div>
<div class="device"></div>
</div>
</div>
</div>
</div>
<div id="property" class="tab-pane">
<h2 class="off-left">属性</h2>
<div id="property_active" class="property item">
<h3 class="name"><code>active</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l88"><code>src/Button.js:88</code></a>
</p>
</div>
<div class="description">
<div class="stdoc-code"><p>激活状态</p>
</div>
</div>
<p><strong>Default:</strong></p>
<code> false</code>
</div>
<div id="property_block" class="property item">
<h3 class="name"><code>block</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l60"><code>src/Button.js:60</code></a>
</p>
</div>
<div class="description">
<div class="stdoc-code"><p>块级显示</p>
</div>
</div>
<p><strong>Default:</strong></p>
<code> false</code>
</div>
<div id="property_classPrefix" class="property item">
<h3 class="name"><code>classPrefix</code></h3>
<span class="type">String</span>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l47"><code>src/Button.js:47</code></a>
</p>
</div>
<div class="description">
<div class="stdoc-code"><p>样式前缀</p>
</div>
</div>
<p><strong>Default:</strong></p>
<code> 'button'</code>
</div>
<div id="property_componentTag" class="property item">
<h3 class="name"><code>componentTag</code></h3>
<span class="type">String</span>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l54"><code>src/Button.js:54</code></a>
</p>
</div>
<div class="description">
<div class="stdoc-code"><p>标签tagName</p>
</div>
</div>
</div>
<div id="property_disabled" class="property item">
<h3 class="name"><code>disabled</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l81"><code>src/Button.js:81</code></a>
</p>
</div>
<div class="description">
<div class="stdoc-code"><p>不可点状态</p>
</div>
</div>
<p><strong>Default:</strong></p>
<code> false</code>
</div>
<div id="property_hollow" class="property item">
<h3 class="name"><code>hollow</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l74"><code>src/Button.js:74</code></a>
</p>
</div>
<div class="description">
<div class="stdoc-code"><p>空背景</p>
</div>
</div>
<p><strong>Default:</strong></p>
<code> false</code>
</div>
<div id="property_phSize" class="property item">
<h3 class="name"><code>phSize</code></h3>
<span class="type">String</span>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l33"><code>src/Button.js:33</code></a>
</p>
</div>
<div class="description">
<div class="stdoc-code"><p>按钮尺寸[sm、md、lg], 默认为sm</p>
</div>
</div>
<p><strong>Default:</strong></p>
<code> 'sm'</code>
</div>
<div id="property_phStyle" class="property item">
<h3 class="name"><code>phStyle</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l40"><code>src/Button.js:40</code></a>
</p>
</div>
<div class="description">
<div class="stdoc-code"><p>按钮颜色[primary、warning、danger、info、error、success、link、gray], 默认primary</p>
</div>
</div>
<p><strong>Default:</strong></p>
<code> 'primary'</code>
</div>
<div id="property_radius" class="property item">
<h3 class="name"><code>radius</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p class="foundat">
Defined in
<a href="../files/src_Button.js.html#l67"><code>src/Button.js:67</code></a>
</p>
</div>
<div class="description">
<div class="stdoc-code"><p>圆角</p>
</div>
</div>
<p><strong>Default:</strong></p>
<code> false</code>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<a id="gotoTop" class='well well-small' href='#'>
</a>
<script src="../assets/vendor/jquery/jquery-1.8.2.js"></script>
<script src="../assets/vendor/bootstrap/js/bootstrap.js"></script>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script src="../assets/js/config.js"></script>
<script src="../assets/js/doc.js"></script>
</body>
</html>