Skip to content

Commit

Permalink
docs(gitbook): built
Browse files Browse the repository at this point in the history
  • Loading branch information
mfrachet committed Jun 4, 2018
1 parent e5d870c commit 00ed22e
Show file tree
Hide file tree
Showing 44 changed files with 6,890 additions and 0 deletions.
398 changes: 398 additions & 0 deletions docs/animations/BUILTIN.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,398 @@

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Built in · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">




<link rel="stylesheet" href="../gitbook/style.css">




<link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">



<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">



<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">























<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">


<link rel="next" href="../customize/CUSTOMANIMATION.html" />


<link rel="prev" href="../customize/CUSTOMCOMPONENT.html" />


</head>
<body>

<div class="book">
<div class="book-summary">


<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>


<nav role="navigation">



<ul class="summary">









<li class="chapter " data-level="1.1" data-path="../">

<a href="../">


Introduction

</a>



</li>




<li class="header">Getting started</li>



<li class="chapter " data-level="2.1" data-path="../getting-started/INSTALLATION.html">

<a href="../getting-started/INSTALLATION.html">


Installation

</a>



</li>

<li class="chapter " data-level="2.2" data-path="../getting-started/EXAMPLE.html">

<a href="../getting-started/EXAMPLE.html">


Example

</a>



</li>




<li class="header">Components</li>



<li class="chapter " data-level="3.1" data-path="../components/LINE.html">

<a href="../components/LINE.html">


Line

</a>



</li>

<li class="chapter " data-level="3.2" data-path="../components/MEDIA.html">

<a href="../components/MEDIA.html">


Media

</a>



</li>

<li class="chapter " data-level="3.3" data-path="../components/PARAGRAPH.html">

<a href="../components/PARAGRAPH.html">


Paragraph

</a>



</li>

<li class="chapter " data-level="3.4" data-path="../components/IMAGECONTENT.html">

<a href="../components/IMAGECONTENT.html">


ImageContent

</a>



</li>

<li class="chapter " data-level="3.5" data-path="../components/MULTIWORDS.html">

<a href="../components/MULTIWORDS.html">


MultiWords

</a>



</li>

<li class="chapter " data-level="3.6" data-path="../customize/CUSTOMCOMPONENT.html">

<a href="../customize/CUSTOMCOMPONENT.html">


Custom component

</a>



</li>




<li class="header">Animations</li>



<li class="chapter active" data-level="4.1" data-path="BUILTIN.html">

<a href="BUILTIN.html">


Built in

</a>



</li>

<li class="chapter " data-level="4.2" data-path="../customize/CUSTOMANIMATION.html">

<a href="../customize/CUSTOMANIMATION.html">


Custom animation

</a>



</li>




<li class="divider"></li>

<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>


</nav>


</div>

<div class="book-body">

<div class="body-inner">



<div class="book-header" role="navigation">


<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href=".." >Built in</a>
</h1>
</div>




<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">

<div id="book-search-results">
<div class="search-noresults">

<section class="normal markdown-section">

<h1 id="built-in">Built in</h1>
<p>The project comes with a <code>connect</code> HOC that brings three global props to every components, <code>onReady</code>, <code>customAnimate</code> and <code>animate</code>.</p>
<p>The <code>animate</code> props uses built in animations such as <a href="https://github.com/mfrachet/rn-placeholder/tree/master/src/animation/shine.js" target="_blank"><code>shine</code></a> or <a href="https://github.com/mfrachet/rn-placeholder/tree/master/src/animation/fade.js" target="_blank"><code>fade</code></a> to animate the placeHolder with a visual effect while waiting for the content to appear.</p>
<p>If you want to display a built in animation, simply specify the props on your <code>Placeholder</code> component :</p>
<p align="center">
<img src="images/shine.gif">
</p>


<pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">Placeholder.ImageContent</span>
<span class="hljs-attr">onReady</span>=<span class="hljs-string">{this.state.isReady}</span>
<span class="hljs-attr">lineNumber</span>=<span class="hljs-string">{2}</span>
<span class="hljs-attr">animate</span>=<span class="hljs-string">&quot;shine&quot;</span>
<span class="hljs-attr">lastLineWidth</span>=<span class="hljs-string">&quot;40%&quot;</span>
&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">Text</span>&gt;</span>Animated placeholder<span class="hljs-tag">&lt;/<span class="hljs-name">Text</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">Placeholder.ImageContent</span>&gt;</span>
</code></pre>


</section>

</div>
<div class="search-results">
<div class="has-results">

<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>

</div>
<div class="no-results">

<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>

</div>
</div>
</div>

</div>
</div>

</div>



<a href="../customize/CUSTOMCOMPONENT.html" class="navigation navigation-prev " aria-label="Previous page: Custom component">
<i class="fa fa-angle-left"></i>
</a>


<a href="../customize/CUSTOMANIMATION.html" class="navigation navigation-next " aria-label="Next page: Custom animation">
<i class="fa fa-angle-right"></i>
</a>



</div>

<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Built in","level":"4.1","depth":1,"next":{"title":"Custom animation","level":"4.2","depth":1,"path":"customize/CUSTOMANIMATION.md","ref":"./customize/CUSTOMANIMATION.md","articles":[]},"previous":{"title":"Custom component","level":"3.6","depth":1,"path":"customize/CUSTOMCOMPONENT.md","ref":"./customize/CUSTOMCOMPONENT.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"animations/BUILTIN.md","mtime":"2017-11-19T13:49:45.724Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-06-04T12:40:15.990Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>


<script src="../gitbook/gitbook.js"></script>
<script src="../gitbook/theme.js"></script>


<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>



<script src="../gitbook/gitbook-plugin-search/search.js"></script>



<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>



<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>



<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>



<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>



</body>
</html>

Binary file added docs/animations/images/shine.gif
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 00ed22e

Please sign in to comment.