Files
ant-design/docs/react/customize-theme.html
T
2016-11-28 14:36:08 +08:00

79 lines
20 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Ant Design - An enterprise-class UI design language and React-based implementation">
<title>Ant Design - One Design Language</title>
<link rel="icon" href="https://t.alipayobjects.com/images/T1QUBfXo4fXXXXXXXX.png" type="image/x-icon">
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.cnpmjs.org/css?family=Lato:400,700|Raleway"/>
<link rel="stylesheet" type="text/css" href="/index-1.css"/>
<link rel="stylesheet" type="text/css" href="/index-2.css"/>
<!--[if lte IE 10]>
<script
src="https://as.alipayobjects.com/g/component/??console-polyfill/0.2.2/index.js,media-match/2.0.2/media.match.min.js"></script>
<![endif]-->
<script>
if (!window.Intl) {
document.writeln('<script src="https://as.alipayobjects.com/g/component/intl/1.0.1/??Intl.js,locale-data/jsonp/en.js,locale-data/jsonp/zh.js">' + '<' + '/script>');
}
if (!window.Promise) {
document.writeln('<script src="https://as.alipayobjects.com/g/component/es6-promise/3.2.2/es6-promise.min.js"' + '>' + '<' + '/' + 'script>');
}
</script>
</head>
<body>
<div id="react-content" hidden>
<div class="page-wrapper" data-reactroot="" data-reactid="1" data-react-checksum="1525668880"><header id="header" class="clearfix" data-reactid="2"><div class="ant-row" data-reactid="3"><div class="ant-col-xs-24 ant-col-sm-24 ant-col-md-6 ant-col-lg-4" data-reactid="4"><a id="logo" href="/" data-reactid="5"><img alt="logo" src="https://t.alipayobjects.com/images/rmsweb/T1B9hfXcdvXXXXXXXX.svg" data-reactid="6"/><span data-reactid="7">Ant Design</span></a></div><div style="display:block;" class="ant-col-xs-0 ant-col-sm-17 ant-col-md-18 ant-col-lg-20" data-reactid="8"><div id="search-box" data-reactid="9"><div class="ant-select ant-select-combobox ant-select-enabled" data-reactid="10"><div class="ant-select-selection
ant-select-selection--single" role="combobox" aria-autocomplete="list" aria-haspopup="true" aria-expanded="false" data-reactid="11"><div class="ant-select-selection__rendered" data-reactid="12"><div style="display:block;user-select:none;-webkit-user-select:none;" unselectable="unselectable" class="ant-select-selection__placeholder" data-reactid="13">Search Components...</div><ul data-reactid="14"><li class="ant-select-search ant-select-search--inline" data-reactid="15"><div class="ant-select-search__field__wrap" data-reactid="16"><input value="" class="ant-select-search__field" data-reactid="17"/><span class="ant-select-search__field__mirror" data-reactid="18"></span></div></li></ul></div><span class="ant-select-arrow" style="user-select:none;-webkit-user-select:none;" unselectable="unselectable" data-reactid="19"><b data-reactid="20"></b></span></div></div></div><button type="button" class="ant-btn ant-btn-ghost ant-btn-sm lang" data-reactid="21"><span data-reactid="22">中文</span></button><ul class="ant-menu ant-menu-horizontal ant-menu-light ant-menu-root" role="menu" aria-activedescendant="" id="nav" tabindex="0" data-reactid="23"><li class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="24"><a href="/" data-reactid="25"><span data-reactid="26">Home</span></a></li><li class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="27"><a href="/docs/spec/introduce" data-reactid="28"><span data-reactid="29">Specification</span></a></li><li class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="30"><a href="/docs/react/introduce" data-reactid="31"><span data-reactid="32">Components</span></a></li><li class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="33"><a href="/docs/pattern/navigation" data-reactid="34"><span data-reactid="35">Pattern</span></a></li><li class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="36"><a href="/docs/practice/cases" data-reactid="37"><span data-reactid="38">Practice</span></a></li><li class="ant-menu-item-selected ant-menu-item" role="menuitem" aria-selected="true" data-reactid="39"><a href="/docs/resource/download" data-reactid="40"><span data-reactid="41">Resource</span></a></li></ul></div></div></header><div class="main-wrapper" data-reactid="42"><div class="ant-row" data-reactid="43"><div class="ant-col-xs-24 ant-col-sm-24 ant-col-md-6 ant-col-lg-4" data-reactid="44"><ul class="ant-menu ant-menu-inline aside-container ant-menu-light ant-menu-root" role="menu" aria-activedescendant="" tabindex="0" data-reactid="45"><li style="padding-left:24px;" class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="46"><a href="docs/react/introduce" data-reactid="47">Ant Design of React</a></li><li style="padding-left:24px;" class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="48"><a href="docs/react/getting-started" data-reactid="49">Getting Started</a></li><li style="padding-left:24px;" class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="50"><a href="docs/react/install" data-reactid="51">Installation</a></li><li style="padding-left:24px;" class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="52"><a href="docs/react/practical-projects" data-reactid="53">Practical Projects</a></li><li style="padding-left:24px;" class="ant-menu-item-selected ant-menu-item" role="menuitem" aria-selected="true" data-reactid="54"><a href="docs/react/customize-theme" data-reactid="55">Customize theme</a></li><li style="padding-left:24px;" class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="56"><a href="changelog" data-reactid="57">Change Log</a></li><li style="padding-left:24px;" class="ant-menu-item" role="menuitem" aria-selected="false" data-reactid="58"><a href="docs/react/upgrade-notes" data-reactid="59">Upgrade Notes</a></li><li class="ant-menu-submenu-inline ant-menu-submenu" data-reactid="60"><div style="padding-left:24px;" class="ant-menu-submenu-title" aria-open="false" aria-owns="1480314943640_0" aria-haspopup="true" data-reactid="61"><h4 data-reactid="62">Components</h4></div><!-- react-empty: 63 --></li></ul></div><div class="main-container ant-col-xs-24 ant-col-sm-24 ant-col-md-18 ant-col-lg-20" data-reactid="64"><article class="markdown" data-reactid="65"><h1 data-reactid="66"><!-- react-text: 67 -->Customize theme<!-- /react-text --><a class="edit-button" href="https://github.com/ant-design/ant-design/blob/master/docs/react/customize-theme.en-US.md" data-reactid="68"><i class="anticon anticon-edit" data-reactid="69"></i></a></h1><section class="toc" data-reactid="70"><ul data-reactid="71"><li data-reactid="72"><a href="#Less-variables" data-reactid="73"><!-- react-text: 74 -->Less variables<!-- /react-text --></a></li><li data-reactid="75"><a href="#How-to-use-it" data-reactid="76"><!-- react-text: 77 -->How to use it<!-- /react-text --></a></li></ul></section><section class="markdown" data-reactid="78"><p data-reactid="79"><!-- react-text: 80 -->Ant Design allows to customize some basic design aspects in order to meet the needs of UI diversity from business and brand, including primary color, border radius, border color, etc.<!-- /react-text --></p><p data-reactid="81"><img src="https://zos.alipayobjects.com/rmsportal/zTFoszBtDODhXfLAazfSpYbSLSEeytoG.png" data-reactid="82"/></p><h2 id="Less-variables" data-reactid="83"><span data-reactid="84"><!-- react-text: 85 -->Less variables<!-- /react-text --></span><a href="#Less-variables" class="anchor" data-reactid="86">#</a></h2><p data-reactid="87"><!-- react-text: 88 -->We are using <!-- /react-text --><a href="http://lesscss.org/" data-reactid="89"><!-- react-text: 90 -->Less<!-- /react-text --></a><!-- react-text: 91 --> as the development language of style. A set of less variables are defined for each design aspect that can be customized to your needs.<!-- /react-text --></p><ul data-reactid="92"><li data-reactid="93"><p data-reactid="94"><a href="https://github.com/ant-design/ant-design/blob/master/components/style/themes/default.less" data-reactid="95"><!-- react-text: 96 -->Default Variables<!-- /react-text --></a></p></li></ul><p data-reactid="97"><!-- react-text: 98 -->Please report an issue if the existing list of variables is not enough for you.<!-- /react-text --></p><h2 id="How-to-use-it" data-reactid="99"><span data-reactid="100"><!-- react-text: 101 -->How to use it<!-- /react-text --></span><a href="#How-to-use-it" class="anchor" data-reactid="102">#</a></h2><p data-reactid="103"><!-- react-text: 104 -->We recommend <!-- /react-text --><a href="http://lesscss.org/usage/#using-less-in-the-browser-modify-variables" data-reactid="105"><!-- react-text: 106 -->modifyVars<!-- /react-text --></a><!-- react-text: 107 --> to override the default values of the variables. There are two ways to achieve it in practice.<!-- /react-text --></p><p data-reactid="108"><!-- react-text: 109 -->You can use this <!-- /react-text --><a href="https://github.com/ant-design/antd-init/tree/master/examples/customize-antd-theme" data-reactid="110"><!-- react-text: 111 -->example<!-- /react-text --></a><!-- react-text: 112 --> as a playground.<!-- /react-text --></p><h3 id="1)-Using-&#x27;theme&#x27;-property-in-package.theme-(recommended-way)" data-reactid="113"><span data-reactid="114"><!-- react-text: 115 -->1) Using &#x27;theme&#x27; property in package.theme (recommended way)<!-- /react-text --></span><a href="#1)-Using-&#x27;theme&#x27;-property-in-package.theme-(recommended-way)" class="anchor" data-reactid="116">#</a></h3><p data-reactid="117"><!-- react-text: 118 -->Specify the <!-- /react-text --><code data-reactid="119"><!-- react-text: 120 -->theme<!-- /react-text --></code><!-- react-text: 121 --> property in <!-- /react-text --><code data-reactid="122"><!-- react-text: 123 -->package.json<!-- /react-text --></code><!-- react-text: 124 --> file, whose value can be either an object or the path to a JS file that contains the custom values of specific variables:<!-- /react-text --></p><ul data-reactid="125"><li data-reactid="126"><p data-reactid="127"><!-- react-text: 128 -->example of directly specifying the custom values as an object:<!-- /react-text --></p></li></ul><pre class="language-js" data-reactid="129"><code data-reactid="130"><span class="token string" >"theme"</span><span class="token punctuation" >:</span> <span class="token punctuation" >{</span>
<span class="token string" >"@primary-color"</span><span class="token punctuation" >:</span> <span class="token string" >"#1DA57A"</span><span class="token punctuation" >,</span>
<span class="token punctuation" >}</span><span class="token punctuation" >,</span></code></pre><ul data-reactid="131"><li data-reactid="132"><p data-reactid="133"><!-- react-text: 134 -->example of specifying a <!-- /react-text --><a href="https://github.com/ant-design/antd-init/blob/master/examples/customize-antd-theme/theme.js" data-reactid="135"><!-- react-text: 136 -->file path<!-- /react-text --></a><!-- react-text: 137 --> to a JS file:<!-- /react-text --></p></li></ul><pre class="language-js" data-reactid="138"><code data-reactid="139"><span class="token string" >"theme"</span><span class="token punctuation" >:</span> <span class="token string" >"./theme.js"</span><span class="token punctuation" >,</span></code></pre><p data-reactid="140"><!-- react-text: 141 -->This approach is working only when using <!-- /react-text --><a href="https://github.com/ant-tool/atool-build" data-reactid="142"><!-- react-text: 143 -->atool-build<!-- /react-text --></a><!-- react-text: 144 -->(built in <!-- /react-text --><a href="https://github.com/ant-design/antd-init" data-reactid="145"><!-- react-text: 146 -->antd-init<!-- /react-text --></a><!-- react-text: 147 --> and <!-- /react-text --><a href="https://github.com/dvajs/dva-cli" data-reactid="148"><!-- react-text: 149 -->dva-cli<!-- /react-text --></a><!-- react-text: 150 -->). If you choose other boilerplates, you can write webpack config about <!-- /react-text --><a href="https://github.com/webpack/less-loader#less-options" data-reactid="151"><!-- react-text: 152 -->less-loader modifyVars<!-- /react-text --></a><!-- react-text: 153 --> like <!-- /react-text --><a href="https://github.com/ant-tool/atool-build/blob/a4b3e3eec4ffc09b0e2352d7f9d279c4c28fdb99/src/getWebpackCommonConfig.js#L131-L138" data-reactid="154"><!-- react-text: 155 -->atool-build <!-- /react-text --></a><!-- react-text: 156 --> does.<!-- /react-text --></p><p data-reactid="157"><!-- react-text: 158 -->Note: Importing less style is necessary. Please specify <!-- /react-text --><code data-reactid="159"><!-- react-text: 160 -->style<!-- /react-text --></code><!-- react-text: 161 --> option of <!-- /react-text --><code data-reactid="162"><!-- react-text: 163 -->babel-plugin-import<!-- /react-text --></code><!-- react-text: 164 --> to be <!-- /react-text --><code data-reactid="165"><!-- react-text: 166 -->true<!-- /react-text --></code><!-- react-text: 167 --> or <!-- /react-text --><code data-reactid="168"><!-- react-text: 169 -->less<!-- /react-text --></code><!-- react-text: 170 --> if you are using it.<!-- /react-text --></p><h3 id="2)-Overriding-Less-variables-(alternative-way)" data-reactid="171"><span data-reactid="172"><!-- react-text: 173 -->2) Overriding Less variables (alternative way)<!-- /react-text --></span><a href="#2)-Overriding-Less-variables-(alternative-way)" class="anchor" data-reactid="174">#</a></h3><p data-reactid="175"><!-- react-text: 176 -->Override variables via less definition files.<!-- /react-text --></p><p data-reactid="177"><!-- react-text: 178 -->Create a standalone less file like the one below, and import it in your project.<!-- /react-text --></p><pre class="language-css" data-reactid="179"><code data-reactid="180"><span class="token atrule" ><span class="token rule" >@import</span> <span class="token string" >"~antd/dist/antd.less"</span><span class="token punctuation" >;</span></span> // import official less entry file
<span class="token atrule" ><span class="token rule" >@import</span> <span class="token string" >"your-theme-file.less"</span><span class="token punctuation" >;</span></span> // override variables here</code></pre><p data-reactid="181"><!-- react-text: 182 -->Note: This way will load the styles of all components, regardless of your demand, which cause <!-- /react-text --><code data-reactid="183"><!-- react-text: 184 -->style<!-- /react-text --></code><!-- react-text: 185 --> option of <!-- /react-text --><code data-reactid="186"><!-- react-text: 187 -->babel-plugin-import<!-- /react-text --></code><!-- react-text: 188 --> not working.<!-- /react-text --></p></section></article></div></div><div class="ant-row" data-reactid="189"><div class="ant-col-xs-24 ant-col-sm-24 ant-col-md-18 ant-col-md-offset-6 ant-col-lg-20 ant-col-lg-offset-4" data-reactid="190"><section class="prev-next-nav" data-reactid="191"><a class="prev-page" href="docs/react/practical-projects" data-reactid="192">Practical Projects</a><a class="next-page" href="changelog" data-reactid="193">Change Log</a></section></div></div></div><footer id="footer" data-reactid="194"><ul data-reactid="195"><li data-reactid="196"><h2 data-reactid="197">GitHub</h2><div data-reactid="198"><a target="_blank " href="https://github.com/ant-design/ant-design" data-reactid="199"><span data-reactid="200">Repository</span></a></div><div data-reactid="201"><a target="_blank" rel="noopener noreferrer" href="https://github.com/dvajs/dva" data-reactid="202">dva</a><!-- react-text: 203 --> - <!-- /react-text --><span data-reactid="204">Framework</span></div><div data-reactid="205"><a target="_blank" rel="noopener noreferrer" href="https://github.com/dvajs/dva-cli" data-reactid="206">dva-cli</a><!-- react-text: 207 --> -<!-- /react-text --><span data-reactid="208">Scaffold</span></div><div data-reactid="209"><a target="_blank" rel="noopener noreferrer" href="http://ant-tool.github.io" data-reactid="210">ant-tool</a><!-- react-text: 211 --> - <!-- /react-text --><span data-reactid="212">Developer Tools</span></div></li><li data-reactid="213"><h2 data-reactid="214"><span data-reactid="215">Links</span></h2><div data-reactid="216"><a href="http://mobile.ant.design" data-reactid="217">Ant Design Mobile</a><span data-reactid="218"> - </span><span data-reactid="219">Mobile</span></div><div data-reactid="220"><a href="https://g2.alipay.com/" data-reactid="221">G2</a><span data-reactid="222"> - </span><span data-reactid="223">Data Visualization</span></div><div data-reactid="224"><a href="https://antv.alipay.com/" data-reactid="225">AntV</a><span data-reactid="226"> - </span><span data-reactid="227">Data Visualization Specification</span></div><div data-reactid="228"><a href="http://motion.ant.design" data-reactid="229">Ant Motion</a><span data-reactid="230"> - </span><span data-reactid="231">Motion</span></div><div data-reactid="232"><a href="http://library.ant.design/" data-reactid="233">AntD Library</a><span data-reactid="234"> - </span><span data-reactid="235">Axure library of Ant Design</span></div><div data-reactid="236"><a href="http://ux.ant.design" data-reactid="237">Ant UX</a><span data-reactid="238"> - </span><span data-reactid="239">Sitemap Template</span></div></li><li data-reactid="240"><h2 data-reactid="241"><span data-reactid="242">Community</span></h2><div data-reactid="243"><a rel="noopener noreferrer" href="/changelog" data-reactid="244"><span data-reactid="245">Change Log</span></a></div><div data-reactid="246"><a target="_blank" rel="noopener noreferrer" href="https://github.com/ant-design/ant-design/issues" data-reactid="247"><span data-reactid="248">Feedback</span></a></div><div data-reactid="249"><a target="_blank" rel="noopener noreferrer" href="https://gitter.im/ant-design/ant-design" data-reactid="250"><span data-reactid="251">Chat Room</span></a></div><div data-reactid="252"><a target="_blank" rel="noopener noreferrer" href="https://github.com/ant-design/ant-design/issues/new" data-reactid="253"><span data-reactid="254">Bug Report</span></a></div></li><li data-reactid="255"><div data-reactid="256"><!-- react-text: 257 -->©2016 <!-- /react-text --><span data-reactid="258">Created by Ant UED</span></div><div data-reactid="259"><!-- react-text: 260 -->Powered by <!-- /react-text --><a href="https://github.com/benjycui/bisheng" data-reactid="261">BiSheng</a></div><div style="margin-top:10px;" data-reactid="262"><span data-reactid="263">Version: </span><div class="ant-select-sm ant-select ant-select-enabled" data-reactid="264"><div class="ant-select-selection
ant-select-selection--single" role="combobox" aria-autocomplete="list" aria-haspopup="true" aria-expanded="false" tabindex="0" data-reactid="265"><div class="ant-select-selection__rendered" data-reactid="266"><div class="ant-select-selection-selected-value" title="1.11.4" style="display:block;opacity:1;" data-reactid="267">1.11.4</div></div><span class="ant-select-arrow" style="user-select:none;-webkit-user-select:none;" unselectable="unselectable" data-reactid="268"><b data-reactid="269"></b></span></div></div></div></li></ul></footer></div>
</div>
<div class="ant-site-loading" id="ant-site-loading">
<img src='https://t.alipayobjects.com/images/rmsweb/T1B9hfXcdvXXXXXXXX.svg'/>
<div id="loading-text">One Design Language</div>
</div>
<script>
(function () {
var content = document.getElementById('loading-text');
if (content) {
content.innerHTML = content.innerHTML.split('').map(function (letter, i) {
var className;
if (i > 0 && i < content.innerText.length - 1) {
className = 'yoyo-x-' + (i % 6);
}
if (letter.trim() === '') {
className += ' blank';
}
return '<span class="' + className + '">' + letter + '</span>';
}).join('');
}
})();
// Enable Google Analytics
if (!location.port) {
/* eslint-disable */
(function (i, s, o, g, r, a, m) {
i['GoogleAnalyticsObject'] = r;
i[r] = i[r] || function () {
(i[r].q = i[r].q || []).push(arguments)
}, i[r].l = 1 * new Date();
a = s.createElement(o),
m = s.getElementsByTagName(o)[0];
a.async = 1;
a.src = g;
m.parentNode.insertBefore(a, m)
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
ga('create', 'UA-72788897-1', 'auto');
ga('send', 'pageview');
/* eslint-enable */
}
</script>
<script src="/common.js"></script>
<script src="/index.js"></script>
</body>
</html>