Skip to content

Commit 8565de7

Browse files
committed
docs: update api for newly added t-compins event and credits section
1 parent 3bb5860 commit 8565de7

File tree

3 files changed

+32
-4
lines changed

3 files changed

+32
-4
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,10 @@ this.overlay = this._toppy
262262
.position(position)
263263
.content(HelloComponent, { propName: 'toppy-test-prop' })
264264
.create();
265+
266+
this.overlay.listen('t_compins').subscribe(comp => {
267+
console.log('component is ready!', comp); // returns HelloComponent
268+
});
265269
```
266270

267271
```typescript
@@ -358,7 +362,7 @@ ToppyControl.listen(eventName:string):Observable<any>
358362
```typescript
359363
/* events */
360364

361-
`t_open`, `t_close`, `t_dynpos`, `t_detach`, `t_posupdate`;
365+
`t_open`, `t_close`, `t_dynpos`, `t_detach`, `t_posupdate`, `t_compins`;
362366
```
363367

364368
### Contribution
@@ -367,7 +371,11 @@ Any kind of contributions ( Typo fix, documentation, code quality, performance,
367371

368372
### Credits
369373

370-
- Icons from [openmoji](http://openmoji.org)
374+
▶ Icons ━ [icons8](https://icons8.com/icons/cotton)
375+
376+
▶ Illustrations ━ [undraw](https://undraw.co/illustrations)
377+
378+
▶ Font icons ━ [feathers](https://feathericons.com)
371379

372380
### Issues
373381

docs/app/utils/content/content.component.html

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,10 @@ <h5 id="component-props"><a href="#component-props">Component Props</a></h5>
127127
.position(position)
128128
.content(HelloComponent, &#123; propName: <span class="hljs-string">'toppy-test-prop'</span> &#125;)
129129
.create();
130+
131+
<span class="hljs-keyword">this</span>.overlay.listen(<span class="hljs-string">'t_compins'</span>).subscribe(<span class="hljs-function"><span class="hljs-params">comp</span> =></span> &#123;
132+
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'component is ready!'</span>, comp); <span class="hljs-comment">// returns HelloComponent</span>
133+
&#125;);
130134
</code></pre>
131135
<pre><code class="hljs language-typescript"><span class="hljs-comment">// host component</span>
132136
<span class="hljs-meta">@Component</span>(&#123;
@@ -300,6 +304,8 @@ <h3 id="api"><a href="#api"><span class="toppy-icon icon-file"></span> API</a></
300304
<pre><code class="hljs language-typescript"><span class="hljs-string">'t_detach'</span>;
301305
</code></pre>
302306
<pre><code class="hljs language-typescript"><span class="hljs-string">'t_posupdate'</span>;
307+
</code></pre>
308+
<pre><code class="hljs language-typescript"><span class="hljs-string">'t_compins'</span>;
303309
</code></pre>
304310
</div>
305311
<hr>
@@ -365,7 +371,9 @@ <h3 id="more"><a href="#more"><span class="toppy-icon icon-hash"></span> More</a
365371
<h5 id="contribution"><a href="#contribution">Contribution</a></h5>
366372
<p>Any kind of contributions ( Typo fix, documentation, code quality, performance, refactor, pipeline, etc., ) are welcome. 😊</p>
367373
<h5 id="credits"><a href="#credits">Credits</a></h5>
368-
<p>Icon imagess are from <a href="http://openmoji.org">openmoji</a></p>
374+
<p>▶ Icons ━ <a href="https://icons8.com/icons/cotton">icons8</a></p>
375+
<p>▶ Illustrations ━ <a href="https://undraw.co/illustrations">undraw</a></p>
376+
<p>▶ Font icons ━ <a href="https://feathericons.com">feathers</a></p>
369377
<h5 id="issues"><a href="#issues">Issues</a></h5>
370378
<p>Found a bug? Have some idea? Or do you have questions? File it in <a href="https://github.com/lokesh-coder/toppy/issues">github issues</a></p>
371379
<h5 id="license"><a href="#license">License</a></h5>

docs/markdown/main.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,10 @@ this.overlay = this._toppy
168168
.position(position)
169169
.content(HelloComponent, { propName: 'toppy-test-prop' })
170170
.create();
171+
172+
this.overlay.listen('t_compins').subscribe(comp => {
173+
console.log('component is ready!', comp); // returns HelloComponent
174+
});
171175
```
172176

173177
```typescript
@@ -349,6 +353,10 @@ type ToppyEventName
349353
't_posupdate';
350354
```
351355

356+
```typescript
357+
't_compins';
358+
```
359+
352360
</div>
353361

354362
---
@@ -477,7 +485,11 @@ Any kind of contributions ( Typo fix, documentation, code quality, performance,
477485

478486
##### Credits
479487

480-
Icon imagess are from [openmoji](http://openmoji.org)
488+
Icons ━ [icons8](https://icons8.com/icons/cotton)
489+
490+
Illustrations ━ [undraw](https://undraw.co/illustrations)
491+
492+
Font icons ━ [feathers](https://feathericons.com)
481493

482494
##### Issues
483495

0 commit comments

Comments
 (0)