Skip to content

Commit 1fc233f

Browse files
committed
docs
1 parent 3f2324a commit 1fc233f

File tree

10 files changed

+38
-38
lines changed

10 files changed

+38
-38
lines changed

docs/classes/_provider_.i18nprovider.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ <h3>constructor</h3>
154154
<aside class="tsd-sources">
155155
<p>Overrides Component.__constructor</p>
156156
<ul>
157-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L24">Provider.tsx:24</a></li>
157+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L24">Provider.tsx:24</a></li>
158158
</ul>
159159
</aside>
160160
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -206,7 +206,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> context<wbr>Version</h3
206206
<div class="tsd-signature tsd-kind-icon">context<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol"> =&nbsp;null</span></div>
207207
<aside class="tsd-sources">
208208
<ul>
209-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L24">Provider.tsx:24</a></li>
209+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L24">Provider.tsx:24</a></li>
210210
</ul>
211211
</aside>
212212
</section>
@@ -216,7 +216,7 @@ <h3>i18n</h3>
216216
<div class="tsd-signature tsd-kind-icon">i18n<span class="tsd-signature-symbol">:</span> <a href="../modules/_types_.html#i18nconfig" class="tsd-signature-type">I18nConfig</a><span class="tsd-signature-symbol"> =&nbsp;rootI18n</span></div>
217217
<aside class="tsd-sources">
218218
<ul>
219-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L22">Provider.tsx:22</a></li>
219+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L22">Provider.tsx:22</a></li>
220220
</ul>
221221
</aside>
222222
</section>
@@ -275,7 +275,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> context<wbr>Type</h3>
275275
<aside class="tsd-sources">
276276
<p>Overrides Component.contextType</p>
277277
<ul>
278-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L20">Provider.tsx:20</a></li>
278+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L20">Provider.tsx:20</a></li>
279279
</ul>
280280
</aside>
281281
</section>
@@ -607,7 +607,7 @@ <h3>component<wbr>Will<wbr>Unmount</h3>
607607
<aside class="tsd-sources">
608608
<p>Overrides ComponentLifecycle.componentWillUnmount</p>
609609
<ul>
610-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L115">Provider.tsx:115</a></li>
610+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L115">Provider.tsx:115</a></li>
611611
</ul>
612612
</aside>
613613
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -673,7 +673,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> create<wbr>I18n</h3>
673673
<li class="tsd-description">
674674
<aside class="tsd-sources">
675675
<ul>
676-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L119">Provider.tsx:119</a></li>
676+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L119">Provider.tsx:119</a></li>
677677
</ul>
678678
</aside>
679679
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -716,7 +716,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> destroy</h3>
716716
<li class="tsd-description">
717717
<aside class="tsd-sources">
718718
<ul>
719-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L145">Provider.tsx:145</a></li>
719+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L145">Provider.tsx:145</a></li>
720720
</ul>
721721
</aside>
722722
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -809,7 +809,7 @@ <h3>render</h3>
809809
<aside class="tsd-sources">
810810
<p>Overrides Component.render</p>
811811
<ul>
812-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L34">Provider.tsx:34</a></li>
812+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L34">Provider.tsx:34</a></li>
813813
</ul>
814814
</aside>
815815
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4>
@@ -872,7 +872,7 @@ <h3>should<wbr>Component<wbr>Update</h3>
872872
<aside class="tsd-sources">
873873
<p>Overrides ComponentLifecycle.shouldComponentUpdate</p>
874874
<ul>
875-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L47">Provider.tsx:47</a></li>
875+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L47">Provider.tsx:47</a></li>
876876
</ul>
877877
</aside>
878878
<h4 class="tsd-parameters-title">Parameters</h4>

docs/classes/_translate_.i18ntranslate.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ <h3>constructor</h3>
151151
<aside class="tsd-sources">
152152
<p>Overrides Component.__constructor</p>
153153
<ul>
154-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Translate.tsx#L18">Translate.tsx:18</a></li>
154+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Translate.tsx#L18">Translate.tsx:18</a></li>
155155
</ul>
156156
</aside>
157157
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -203,7 +203,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> context<wbr>Version</h3
203203
<div class="tsd-signature tsd-kind-icon">context<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol"> =&nbsp;null</span></div>
204204
<aside class="tsd-sources">
205205
<ul>
206-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Translate.tsx#L18">Translate.tsx:18</a></li>
206+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Translate.tsx#L18">Translate.tsx:18</a></li>
207207
</ul>
208208
</aside>
209209
</section>
@@ -262,7 +262,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> context<wbr>Type</h3>
262262
<aside class="tsd-sources">
263263
<p>Overrides Component.contextType</p>
264264
<ul>
265-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Translate.tsx#L16">Translate.tsx:16</a></li>
265+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Translate.tsx#L16">Translate.tsx:16</a></li>
266266
</ul>
267267
</aside>
268268
</section>
@@ -742,7 +742,7 @@ <h3>render</h3>
742742
<aside class="tsd-sources">
743743
<p>Overrides Component.render</p>
744744
<ul>
745-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Translate.tsx#L27">Translate.tsx:27</a></li>
745+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Translate.tsx#L27">Translate.tsx:27</a></li>
746746
</ul>
747747
</aside>
748748
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
@@ -805,7 +805,7 @@ <h3>should<wbr>Component<wbr>Update</h3>
805805
<aside class="tsd-sources">
806806
<p>Overrides ComponentLifecycle.shouldComponentUpdate</p>
807807
<ul>
808-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Translate.tsx#L53">Translate.tsx:53</a></li>
808+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Translate.tsx#L53">Translate.tsx:53</a></li>
809809
</ul>
810810
</aside>
811811
<h4 class="tsd-parameters-title">Parameters</h4>

docs/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h2 id="api">API</h2>
9898
};</code></pre>
9999
<p><a href="https://trigensoftware.github.io/i18n-for-react/index.html">Description of this methods you can find in Documentation.</a></p>
100100
<p>Basic API is same as in <a href="https://github.com/TrigenSoftware/i18n-for-browser"><code>i18n-for-browser</code> module.</a></p>
101-
<h3 id="i18nprovider"><a href="https://trigensoftware.github.io/i18n-for-react/modules/_index_.html#i18nprovider">I18nProvider</a></h3>
101+
<h3 id="i18nprovider"><a href="https://trigensoftware.github.io/i18n-for-react/interfaces/_provider_.ii18nproviderconfig.html">I18nProvider</a></h3>
102102
<p>Configurator and provider of <code>i18n</code> instance.</p>
103103
<p>Root context configuration example:</p>
104104
<pre><code class="language-jsx">&lt;I18nProvider
@@ -128,7 +128,7 @@ <h3 id="i18nprovider"><a href="https://trigensoftware.github.io/i18n-for-react/m
128128
{__`goodby`}
129129
&lt;/I18nProvider&gt;
130130
&lt;/I18nProvider&gt;</code></pre>
131-
<h3 id="withi18n"><a href="https://trigensoftware.github.io/i18n-for-react/modules/_index_.html#withi18n">withI18n</a></h3>
131+
<h3 id="withi18n"><a href="https://trigensoftware.github.io/i18n-for-react/modules/_withi18n_.html#withi18n">withI18n</a></h3>
132132
<p>Decorator to configure provider of <code>i18n</code> instance.</p>
133133
<p>Example:</p>
134134
<pre><code class="language-jsx">@withI18n({
@@ -159,7 +159,7 @@ <h3 id="withi18n"><a href="https://trigensoftware.github.io/i18n-for-react/modul
159159
);
160160
}
161161
}</code></pre>
162-
<h3 id="rprintf-"><a href="https://trigensoftware.github.io/i18n-for-react/modules/_index_.html#rprintf">rprintf()</a></h3>
162+
<h3 id="rprintf-"><a href="https://trigensoftware.github.io/i18n-for-react/modules/_rptintf_.html#rptintf">rprintf()</a></h3>
163163
<p>Every translate function support React-formatted output:</p>
164164
<pre><code class="language-jsx">__('Hi, &lt;&gt;%s&lt;/&gt;!', 'username', [&lt;b/&gt;])
165165
// or

docs/interfaces/_provider_.ii18nproviderconfig.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> context</h3>
111111
<div class="tsd-signature tsd-kind-icon">context<span class="tsd-signature-symbol">:</span> <a href="../modules/_types_.html#i18nconfig" class="tsd-signature-type">I18nConfig</a></div>
112112
<aside class="tsd-sources">
113113
<ul>
114-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L14">Provider.tsx:14</a></li>
114+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L14">Provider.tsx:14</a></li>
115115
</ul>
116116
</aside>
117117
</section>
@@ -169,7 +169,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hardfork</h3>
169169
<div class="tsd-signature tsd-kind-icon">hardfork<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
170170
<aside class="tsd-sources">
171171
<ul>
172-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L15">Provider.tsx:15</a></li>
172+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L15">Provider.tsx:15</a></li>
173173
</ul>
174174
</aside>
175175
</section>
@@ -179,7 +179,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> locale</h3>
179179
<div class="tsd-signature tsd-kind-icon">locale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
180180
<aside class="tsd-sources">
181181
<ul>
182-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Provider.tsx#L13">Provider.tsx:13</a></li>
182+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Provider.tsx#L13">Provider.tsx:13</a></li>
183183
</ul>
184184
</aside>
185185
</section>

docs/interfaces/_translate_.iprops.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3>args</h3>
102102
<div class="tsd-signature tsd-kind-icon">args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div>
103103
<aside class="tsd-sources">
104104
<ul>
105-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Translate.tsx#L10">Translate.tsx:10</a></li>
105+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Translate.tsx#L10">Translate.tsx:10</a></li>
106106
</ul>
107107
</aside>
108108
</section>
@@ -119,7 +119,7 @@ <h3>fn</h3>
119119
<li class="tsd-description">
120120
<aside class="tsd-sources">
121121
<ul>
122-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/Translate.tsx#L11">Translate.tsx:11</a></li>
122+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/Translate.tsx#L11">Translate.tsx:11</a></li>
123123
</ul>
124124
</aside>
125125
<h4 class="tsd-parameters-title">Parameters</h4>

docs/interfaces/_withi18n_.iprops.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3>component<wbr>Ref</h3>
100100
<li class="tsd-description">
101101
<aside class="tsd-sources">
102102
<ul>
103-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/withI18n.tsx#L12">withI18n.tsx:12</a></li>
103+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/withI18n.tsx#L12">withI18n.tsx:12</a></li>
104104
</ul>
105105
</aside>
106106
<h4 class="tsd-parameters-title">Parameters</h4>

docs/modules/_index_.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h3>__</h3>
9191
<li class="tsd-description">
9292
<aside class="tsd-sources">
9393
<ul>
94-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/index.tsx#L35">index.tsx:35</a></li>
94+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/index.tsx#L35">index.tsx:35</a></li>
9595
</ul>
9696
</aside>
9797
<div class="tsd-comment tsd-typography">
@@ -129,7 +129,7 @@ <h3>__mf</h3>
129129
<li class="tsd-description">
130130
<aside class="tsd-sources">
131131
<ul>
132-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/index.tsx#L56">index.tsx:56</a></li>
132+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/index.tsx#L56">index.tsx:56</a></li>
133133
</ul>
134134
</aside>
135135
<div class="tsd-comment tsd-typography">
@@ -173,7 +173,7 @@ <h3>__n</h3>
173173
<li class="tsd-description">
174174
<aside class="tsd-sources">
175175
<ul>
176-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/index.tsx#L76">index.tsx:76</a></li>
176+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/index.tsx#L76">index.tsx:76</a></li>
177177
</ul>
178178
</aside>
179179
<div class="tsd-comment tsd-typography">
@@ -210,7 +210,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactElem
210210
<li class="tsd-description">
211211
<aside class="tsd-sources">
212212
<ul>
213-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/index.tsx#L91">index.tsx:91</a></li>
213+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/index.tsx#L91">index.tsx:91</a></li>
214214
</ul>
215215
</aside>
216216
<div class="tsd-comment tsd-typography">
@@ -247,7 +247,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReactElem
247247
<li class="tsd-description">
248248
<aside class="tsd-sources">
249249
<ul>
250-
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/b6a5283/src/index.tsx#L107">index.tsx:107</a></li>
250+
<li>Defined in <a href="https://github.com/TrigenSoftware/i18n-for-react/blob/3f2324a/src/index.tsx#L107">index.tsx:107</a></li>
251251
</ul>
252252
</aside>
253253
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)