UNPKG

phoenix-ui

Version:
1,001 lines (569 loc) 29.3 kB
<!DOCTYPE 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>Steps - 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>Steps</h1> </div> <div class="well well-small sign-left3"> <div class="stdoc-code"><p>步骤组件<br/></p> <ul> <li>通过list设置步骤过程名称数组,如["合作信息","公司信息","资质信息"],必需。</li> <li>可通过currentStep设置当前步骤,从0开始计算。</li> <li>可通过clickCallback设置点击步骤的回调,函数返回步骤名称和索引。</li> <li>可通过readOnly设置步骤是否只读不可点击,默认可点击。</li> </ul> <p>主要属性和接口:</p> <ul> <li>list:初始进度百分比, 默认0。 <br/> 如: <code>&lt;Steps list={["合作信息","公司信息","资质信息"]} /&gt;</code></li> <li>currentStep:当前步骤,从0开始计算,默认0。 <br/> 如: <code>&lt;Steps currentStep={1} list={["合作信息","公司信息","资质信息"]} /&gt;</code></li> <li>clickCallback:点击步骤的回调,函数返回步骤名称和索引。 <br/> 如: <code>&lt;Steps clickCallback={(str,index)=&gt;{console.log(index);}} list={["合作信息","公司信息","资质信息"]}/&gt;</code></li> <li>readOnly:只读不可点击,默认false。<br/> 如: <code>&lt;Steps readOnly list={["合作信息","公司信息","资质信息"]} /&gt;</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> <ul class="index-list methods extends"> <li class="index-item method"> <a href="#" data-tabid="#method" data-anchor="#method_clickCallback" data-tablink="clickCallback">clickCallback</a> </li> </ul> </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_classPrefix" data-tablink="classPrefix">classPrefix</a> </li> <li class="index-item property"> <a href="#" data-tabid="#property" data-anchor="#property_currentStep" data-tablink="currentStep">currentStep</a> </li> <li class="index-item property"> <a href="#" data-tabid="#property" data-anchor="#property_list" data-tablink="list">list</a> </li> <li class="index-item property"> <a href="#" data-tabid="#property" data-anchor="#property_readOnly" data-tablink="readOnly">readOnly</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="#method">方法</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_Steps.js.html#l7"><code>src&#x2F;Steps.js:7</code></a> </div> Module: <a href="../modules/操作类组件.html">操作类组件</a> <p>Available since 1.7.0</p> </div> <div class="constructor"> <h2>Constructor</h2> <div id="method_Steps" class="method item"> <h3 class="name">Steps</h3> <code> Steps <span class="paren">()</span> </code> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_Steps.js.html#l7"><code>src&#x2F;Steps.js:7</code></a> </p> <p>Available since 1.7.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#/steps" _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 {Steps} from "phoenix-ui"; import Code from "./code/code"; export default class steps extends Component{ constructor(props,context){ super(props,context); this.state = { index: 2, list1: ["合作信息","公司信息","资质信息","资质信息"], list2: ["合作信息","公司信息","资质信息","公司信息","资质信息","公司信息"] }; } clickCallback(str, index){ alert("name: "+str+", index: "+index); } render(){ return( &lt;div&gt; &lt;h2 className="comp-title"&gt;Steps&lt;/h2&gt; &lt;h3 className="comp-type"&gt;list(默认[],必需) 步骤名称列表,根据顺序排列&lt;/h3&gt; &lt;div className="content"&gt; &lt;Steps list={["合作信息","公司信息","资质信息"]} /&gt; &lt;/div&gt; &lt;Code target="steps-list" /&gt; &lt;h3 className="comp-type"&gt;currentStep(默认0) 当前步骤(从0开始)&lt;/h3&gt; &lt;div className="content"&gt; &lt;Steps currentStep={2} list={this.state.list1} /&gt; &lt;/div&gt; &lt;Code target="steps-currentstep" /&gt; &lt;h3 className="comp-type"&gt;clickCallback(默认null) 选择步骤的回调函数&lt;/h3&gt; &lt;div className="content"&gt; &lt;Steps clickCallback={::this.clickCallback} list={this.state.list1}/&gt; &lt;/div&gt; &lt;Code target="steps-clickcallback" /&gt; &lt;h3 className="comp-type"&gt;readOnly(默认false) 是否只读,只读时不可点击选择步骤&lt;/h3&gt; &lt;div className="content"&gt; &lt;Steps readOnly list={this.state.list2} /&gt; &lt;/div&gt; &lt;Code target="steps-readonly" /&gt; &lt;/div&gt; ); } }</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="method" class="tab-pane"> <h2 class="off-left">方法</h2> <div id="method_clickCallback" class="method item"> <h3 class="name">clickCallback</h3> <code> clickCallback <span class="paren">()</span> </code> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_Steps.js.html#l63"><code>src&#x2F;Steps.js:63</code></a> </p> </div> <div class="description well well-small sign-left3"> <div class="stdoc-code"><p>点击每一步的回调,function(str,index){} str为步骤名称,index为第几步(从1开始计数)</p> </div> </div> </div> </div> <div id="property" class="tab-pane"> <h2 class="off-left">属性</h2> <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_Steps.js.html#l35"><code>src&#x2F;Steps.js:35</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>样式前缀</p> </div> </div> <p><strong>Default:</strong></p> <code> &#x27;badge&#x27;</code> </div> <div id="property_currentStep" class="property item"> <h3 class="name"><code>currentStep</code></h3> <span class="type">Number</span> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_Steps.js.html#l56"><code>src&#x2F;Steps.js:56</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>当前处于第几步,默认为0,也就是说所有的步骤都没有开始,如果到第一步的话将currentStep设置为1即可,注意currentStep不可以超过list数组长度</p> </div> </div> <p><strong>Default:</strong></p> <code> 0</code> </div> <div id="property_list" class="property item"> <h3 class="name"><code>list</code></h3> <span class="type">Array</span> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_Steps.js.html#l49"><code>src&#x2F;Steps.js:49</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>steps内容数组,把每一步的文案放入数组中作为list的值</p> </div> </div> <p><strong>Default:</strong></p> <code> []</code> </div> <div id="property_readOnly" class="property item"> <h3 class="name"><code>readOnly</code></h3> <span class="type">Boolean</span> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_Steps.js.html#l42"><code>src&#x2F;Steps.js:42</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>是否为只读模式(只读模式不会触发点击回调),默认为false</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>