Skip to content

Commit 6f4ac2a

Browse files
MarkGriffithsMarkGriffiths
committedNov 5, 2021
Update Dependencies
·
v4.0.4v4.0.1
1 parent 8f4f8d0 commit 6f4ac2a

File tree

1 file changed

+16
-76
lines changed

1 file changed

+16
-76
lines changed
 

‎docs/index.html

+16-76
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,6 @@ <h3 class="m0 no-anchor">truwrap</h3>
4545
</li>
4646

4747

48-
<li><a
49-
href="#rendermode"
50-
class="">
51-
renderMode
52-
53-
</a>
54-
55-
</li>
56-
57-
5848
<li><a
5949
href="#truwrap"
6050
class=" toggle-sibling">
@@ -163,6 +153,13 @@ <h4>Installation</h4>
163153
writer.<span class="hljs-title function_">write</span>(<span class="hljs-string">&quot;Some text to write...&quot;</span>, <span class="hljs-string">&quot;...and some more.&quot;</span>)
164154
writer.<span class="hljs-title function_">write</span>(<span class="hljs-string">&quot;A new paragraph, if not implicitly present.&quot;</span>)
165155
writer.<span class="hljs-title function_">end</span>() <span class="hljs-comment">// Close the stream</span></pre>
156+
<p><code>mode</code> can be set to the following values:</p>
157+
<ul>
158+
<li><code>soft</code>: words are broken before the column width, giving a left justified appearance.</li>
159+
<li><code>hard</code>: words are split at the column width.</li>
160+
<li><code>keep</code>: lines longer than the column width are kept.</li>
161+
<li><code>container</code>: left and right margins are ignored, giving a full width line.</li>
162+
</ul>
166163
<p>As <code>outStream</code> was specified, wrapped output is written directly to the stream.</p>
167164
<h3>Images</h3>
168165
<p>If your terminal suppots them, you can add images into the wrapped output ste</p>
@@ -173,7 +170,7 @@ <h3>Images</h3>
173170
<span class="hljs-attr">file</span>: <span class="hljs-title function_">join</span>(<span class="hljs-title function_">dirname</span>(<span class="hljs-title function_">fileURLToPath</span>(<span class="hljs-keyword">import</span>.<span class="hljs-property">meta</span>.<span class="hljs-property">url</span>)), <span class="hljs-string">&#x27;../media/test.png&#x27;</span>),
174171
<span class="hljs-attr">width</span>: <span class="hljs-string">&#x27;auto&#x27;</span>, <span class="hljs-comment">// Number of chars wide you&#x27;d like image. &#x27;auto&#x27; to take it from the image/set height.</span>
175172
<span class="hljs-attr">height</span>: <span class="hljs-number">1</span>, <span class="hljs-comment">// Number of lines the image will take</span>
176-
<span class="hljs-attr">space</span>: <span class="hljs-string">&#x27; &#x27;</span> <span class="hljs-comment">// A text string that is printed under the image so you can flow the wrapped text around it.</span>
173+
<span class="hljs-attr">space</span>: <span class="hljs-string">&#x27; &#x27;</span> <span class="hljs-comment">// A text string that is printed under the image so you can flow the wrapped text around it.</span>
177174
})
178175

179176
<span class="hljs-keyword">var</span> renderer = <span class="hljs-title function_">truwrap</span>({
@@ -236,63 +233,6 @@ <h2 id="api" class="m0">
236233

237234

238235

239-
<section class='p2 pl3 mb2 ml2 mr2 clearfix bg-white rounded minishadow'>
240-
241-
242-
<div class='clearfix'>
243-
244-
<h3 class='left m0 panel-title' id='rendermode'>
245-
renderMode
246-
247-
</h3>
248-
249-
250-
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/35bd1e2ad55be3dd622b3be0879ad9ea19b50fcb/src/index.js#L16-L21'>
251-
<span>src/index.js</span>
252-
</a>
253-
254-
</div>
255-
256-
257-
<p>Create an n-selector for module modes</p>
258-
259-
260-
<div class='pre p1 bg-darken-1 mt0 rounded signature'>renderMode</div>
261-
262-
<p>
263-
Type:
264-
<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">Function</a>
265-
</p>
266-
267-
268-
269-
270-
271-
272-
273-
274-
275-
276-
277-
278-
279-
280-
281-
282-
283-
284-
285-
286-
287-
288-
289-
290-
291-
</section>
292-
293-
294-
295-
296236
<section class='p2 pl3 mb2 ml2 mr2 clearfix bg-white rounded minishadow'>
297237

298238

@@ -304,7 +244,7 @@ <h3 class='left m0 panel-title' id='truwrap'>
304244
</h3>
305245

306246

307-
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/35bd1e2ad55be3dd622b3be0879ad9ea19b50fcb/src/index.js#L28-L216'>
247+
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/8f4f8d05943ec1ef486df54963fec076e0e8d00a/src/index.js#L15-L202'>
308248
<span>src/index.js</span>
309249
</a>
310250

@@ -457,7 +397,7 @@ <h3 class='left m0 panel-title' id='truwrap'>
457397
<div class='clearfix'>
458398

459399

460-
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/35bd1e2ad55be3dd622b3be0879ad9ea19b50fcb/src/index.js#L97-L111'>
400+
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/8f4f8d05943ec1ef486df54963fec076e0e8d00a/src/index.js#L83-L97'>
461401
<span>src/index.js</span>
462402
</a>
463403

@@ -520,7 +460,7 @@ <h3 class='left m0 panel-title' id='truwrap'>
520460
<div class='clearfix'>
521461

522462

523-
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/35bd1e2ad55be3dd622b3be0879ad9ea19b50fcb/src/index.js#L118-L127'>
463+
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/8f4f8d05943ec1ef486df54963fec076e0e8d00a/src/index.js#L104-L113'>
524464
<span>src/index.js</span>
525465
</a>
526466

@@ -583,7 +523,7 @@ <h3 class='left m0 panel-title' id='truwrap'>
583523
<div class='clearfix'>
584524

585525

586-
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/35bd1e2ad55be3dd622b3be0879ad9ea19b50fcb/src/index.js#L136-L155'>
526+
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/8f4f8d05943ec1ef486df54963fec076e0e8d00a/src/index.js#L122-L141'>
587527
<span>src/index.js</span>
588528
</a>
589529

@@ -669,7 +609,7 @@ <h3 class='left m0 panel-title' id='truwrap'>
669609
<div class='clearfix'>
670610

671611

672-
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/35bd1e2ad55be3dd622b3be0879ad9ea19b50fcb/src/index.js#L163-L172'>
612+
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/8f4f8d05943ec1ef486df54963fec076e0e8d00a/src/index.js#L149-L158'>
673613
<span>src/index.js</span>
674614
</a>
675615

@@ -747,7 +687,7 @@ <h3 class='left m0 panel-title' id='truwrap'>
747687
<div class='clearfix'>
748688

749689

750-
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/35bd1e2ad55be3dd622b3be0879ad9ea19b50fcb/src/index.js#L179-L188'>
690+
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/8f4f8d05943ec1ef486df54963fec076e0e8d00a/src/index.js#L165-L174'>
751691
<span>src/index.js</span>
752692
</a>
753693

@@ -810,7 +750,7 @@ <h3 class='left m0 panel-title' id='truwrap'>
810750
<div class='clearfix'>
811751

812752

813-
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/35bd1e2ad55be3dd622b3be0879ad9ea19b50fcb/src/index.js#L196-L215'>
753+
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/8f4f8d05943ec1ef486df54963fec076e0e8d00a/src/index.js#L182-L201'>
814754
<span>src/index.js</span>
815755
</a>
816756

@@ -896,7 +836,7 @@ <h3 class='left m0 panel-title' id='truwrap'>
896836
</h3>
897837

898838

899-
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/35bd1e2ad55be3dd622b3be0879ad9ea19b50fcb/src/index.js#L232-L234'>
839+
<a class='pl3 pr1 right rounded github' href='https://github.com/thebespokepixel/truwrap/blob/8f4f8d05943ec1ef486df54963fec076e0e8d00a/src/index.js#L218-L220'>
900840
<span>src/index.js</span>
901841
</a>
902842

0 commit comments

Comments
 (0)
Please sign in to comment.