UNPKG

phoenix-ui

Version:
1,173 lines (665 loc) 34.1 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>ImageList - 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>ImageList</h1> </div> <div class="well well-small sign-left3"> <div class="stdoc-code"><p>图片列表组件<br/></p> <ul> <li>通过images配置图片列表数据,数组格式,其中图片地址对应<code>image</code>字段,名称对应<code>title</code>字段,描述对应<code>desp</code>字段。</li> <li>通过column设置图片列表的列数,1-8列。</li> <li>通过titleField设置名称的格式,以<code>#</code>代表名称;通过despField设置描述的格式,以<code>#</code>代表描述。</li> <li>通过otherParams设置额外的字段和格式。</li> <li>通过clickCallback设置点击单个图片块的回调函数,返回当前图片的所有数据。</li> <li>可以自定义内容children,当有内容时除了column其他属性不起作用。</li> </ul> <p>主要属性和接口:</p> <ul> <li>images:图片列表数据,默认[]。<br><pre><code class="lang-code">json: { "data": [ { "image": "http://img5.duitang.com/uploads/item/201602/11/20160211214958_RhdCY.jpeg", "title": "图1", "desp": "关于图是一个...", "score": 1 }, ... ] } ... &lt;ImageList images={this.state.images} /&gt;</code></pre> </li> <li>column:列表的列数,默认1。<br> 如: <code>&lt;ImageList column={2} images={this.state.images} /&gt;</code></li> <li>titleField:名称的格式,以<code>#</code>代表名称,默认"#"despField:描述的格式,以<code>#</code>代表描述,默认"#"。<br> 如: <code>&lt;ImageList images={this.state.images} titleField={"姓名: #"} despField={"描述: #"} /&gt;</code></li> <li>otherParams:额外的字段和格式,默认{}。<br> 如: <code>&lt;ImageList images={this.state.images} otherParams={{"score":"分数: #"}} /&gt;</code></li> <li>clickCallback:点击单个图片块的回调函数。<br> 如: <code>&lt;ImageList images={this.state.images} clickCallback={(data)=&gt;{console.log(data);}} /&gt;</code></li> <li>自定义内容:children,当有内容时除了column其他属性不起作用。<pre><code class="lang-code">&lt;ImageList column={4}&gt; { this.state.images.map((data,index)=&gt;{ return ( &lt;dl key={index}&gt; &lt;dd&gt; &lt;p&gt;{data.title}&lt;/p&gt; &lt;p&gt;{data.desp}&lt;/p&gt; &lt;/dd&gt; &lt;dt&gt; &lt;img src={data.image} alt={data.title} /&gt; &lt;/dt&gt; &lt;/dl&gt; ) }) } &lt;/ImageList&gt;</code></pre> </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_column" data-tablink="column">column</a> </li> <li class="index-item property"> <a href="#" data-tabid="#property" data-anchor="#property_despField" data-tablink="despField">despField</a> </li> <li class="index-item property"> <a href="#" data-tabid="#property" data-anchor="#property_images" data-tablink="images">images</a> </li> <li class="index-item property"> <a href="#" data-tabid="#property" data-anchor="#property_otherParams" data-tablink="otherParams">otherParams</a> </li> <li class="index-item property"> <a href="#" data-tabid="#property" data-anchor="#property_titleField" data-tablink="titleField">titleField</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_ImageList.js.html#l6"><code>src&#x2F;ImageList.js:6</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_ImageList" class="method item"> <h3 class="name">ImageList</h3> <code> ImageList <span class="paren">()</span> </code> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_ImageList.js.html#l6"><code>src&#x2F;ImageList.js:6</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#/imagelist" _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 {ImageList} from "phoenix-ui"; import Code from "./code/code"; import {ajax} from "./utils/tool.js"; export default class imagelist extends Component{ constructor(props,context){ super(props,context); this.state = { images: [] } this.getData("./data/post1.json",0); } getData(fileName){ // 获取数据方法,ajax方法在下面定义了 ajax(fileName).then((json)=&gt;{ let data = json.data; this.setState({ images: data }); }, (error)=&gt;{// 加载失败 console.error("出错了", error) }); } render(){ return( &lt;div&gt; &lt;h2 className="comp-title"&gt;ImageList&lt;/h2&gt; &lt;h3 className="comp-type"&gt;images(默认[]) 图片数据&lt;br/&gt;默认地址的字段是image,名称的字段是title,描述的字段是desp&lt;/h3&gt; &lt;ImageList images={this.state.images} column={4} /&gt; &lt;Code target="imagelist-images" /&gt; &lt;h3 className="comp-type"&gt;column(默认1) 图片列数&lt;/h3&gt; &lt;ImageList column={2} images={this.state.images} /&gt; &lt;Code target="imagelist-column" /&gt; &lt;h3 className="comp-type"&gt;titleField(默认#) 姓名格式更改,#代表数值;&lt;br/&gt;despField(默认#) 描述格式更改,#代表数值&lt;/h3&gt; &lt;ImageList images={this.state.images} column={4} titleField={"姓名: #"} despField={"描述: #"} /&gt; &lt;h3 className="comp-tip"&gt; 如果name或desp中有不要的字段,传空字符"" &lt;/h3&gt; &lt;ImageList images={this.state.images} column={4} titleField={"姓名: #"} despField={""} /&gt; &lt;Code target="imagelist-format" /&gt; &lt;h3 className="comp-type"&gt;otherParams(默认{}) 其他增加项&lt;/h3&gt; &lt;ImageList images={this.state.images} column={4} otherParams={{"score":"分数: #"}} /&gt; &lt;Code target="imagelist-otherparams" /&gt; &lt;h3 className="comp-type"&gt;clickCallback(默认null) 点击单个图片块的回调函数&lt;/h3&gt; &lt;ImageList images={this.state.images} column={4} clickCallback={(data)=&gt;{console.log(data);}} /&gt; &lt;Code target="imagelist-clickcallback" /&gt; &lt;h3 className="comp-type"&gt;children(默认无) 内容完全自定义&lt;/h3&gt; &lt;ImageList column={4}&gt; { this.state.images.map((data,index)=&gt;{ return ( &lt;dl key={index}&gt; &lt;dd&gt; &lt;p className="ph-image-title"&gt;{data.title}&lt;/p&gt; &lt;p className="ph-image-desp"&gt;{data.desp}&lt;/p&gt; &lt;/dd&gt; &lt;dt&gt; &lt;img src={data.image} alt={data.title} /&gt; &lt;/dt&gt; &lt;/dl&gt; ) }) } &lt;/ImageList&gt; &lt;Code target="imagelist-custom" /&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_ImageList.js.html#l115"><code>src&#x2F;ImageList.js:115</code></a> </p> </div> <div class="description well well-small sign-left3"> <div class="stdoc-code"><p>点击单个图片块的回调函数,返回当前图片的所有信息</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_ImageList.js.html#l73"><code>src&#x2F;ImageList.js:73</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>样式前缀</p> </div> </div> <p><strong>Default:</strong></p> <code> &#x27;image-list&#x27;</code> </div> <div id="property_column" class="property item"> <h3 class="name"><code>column</code></h3> <span class="type">Number</span> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_ImageList.js.html#l87"><code>src&#x2F;ImageList.js:87</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>图片列数</p> </div> </div> <p><strong>Default:</strong></p> <code> 1</code> </div> <div id="property_despField" class="property item"> <h3 class="name"><code>despField</code></h3> <span class="type">String</span> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_ImageList.js.html#l101"><code>src&#x2F;ImageList.js:101</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>描述格式</p> </div> </div> <p><strong>Default:</strong></p> <code> &quot;#&quot;</code> </div> <div id="property_images" class="property item"> <h3 class="name"><code>images</code></h3> <span class="type">Array</span> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_ImageList.js.html#l80"><code>src&#x2F;ImageList.js:80</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>图片列表数据</p> </div> </div> <p><strong>Default:</strong></p> <code> []</code> </div> <div id="property_otherParams" class="property item"> <h3 class="name"><code>otherParams</code></h3> <span class="type">Object</span> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_ImageList.js.html#l108"><code>src&#x2F;ImageList.js:108</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>其他参数,额外增加的可自定义的字段</p> </div> </div> <p><strong>Default:</strong></p> <code> {}</code> </div> <div id="property_titleField" class="property item"> <h3 class="name"><code>titleField</code></h3> <span class="type">String</span> <div class="meta"> <p class="foundat"> Defined in <a href="../files/src_ImageList.js.html#l94"><code>src&#x2F;ImageList.js:94</code></a> </p> </div> <div class="description"> <div class="stdoc-code"><p>名称格式</p> </div> </div> <p><strong>Default:</strong></p> <code> &quot;#&quot;</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>