Skip to content

Commit 5f9f04d

Browse files
committed
Screenshots now working in generated docs
1 parent c60cca9 commit 5f9f04d

File tree

20 files changed

+40
-10
lines changed

20 files changed

+40
-10
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Svelte Data Table based on [Flowbite Svelte](https://flowbite-svelte.com/), [Flowbite Icons](https://flowbite.com/icons/), and [Tailwind](https://tailwindcss.com/)
22

3-
This data table is designed for viewing and editing data in an array of objects. It works in conjunction with the Flowbite Svelte library, with support for custom cell editors, moving focus between cells with tab and enter, column sorting (simple and custom), conditional CSS, and more.
3+
This data table is designed for viewing and editing data in an array of objects. It's built using the Flowbite Svelte library's Table components and works in conjunction with it, with support for custom cell editors, moving focus between cells with tab and enter, column sorting (simple and custom), conditional CSS, and more.
44

55
## Install
66

@@ -44,4 +44,22 @@ Then install the Flowbite components and icons along with the data table compone
4444
</main>
4545
```
4646

47-
Examples for most of the component's features are under /examples . You can find the documentation [here](https://emamid.github.io/svelte-data-table/).
47+
Examples for most of the component's features are under /examples . You can find the documentation [here](https://emamid.github.io/svelte-data-table/).
48+
49+
#### Example 1 - Basic data table
50+
![Example 1](./screenshot-01.png)
51+
52+
#### Example 2 - Table with cell focus components
53+
![Example 2](./screenshot-02.png)
54+
55+
#### Example 3 - Table with cell focus Select components, cell renderers, and custom sort
56+
![Example 3](./screenshot-03.png)
57+
58+
#### Example 4 - Table with actions and cell view components
59+
![Example 4](./screenshot-04.png)
60+
61+
#### Example 5 - Table with custom cell component
62+
![Example 5](./screenshot-05.png)
63+
64+
#### Example 6 - Table with cell and row class getter functions
65+
![Example 6](./screenshot-06.png)

docs/index.html

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h3> </h3>
101101

102102
<section>
103103
<article><h2>Svelte Data Table based on <a href="https://flowbite-svelte.com/">Flowbite Svelte</a>, <a href="https://flowbite.com/icons/">Flowbite Icons</a>, and <a href="https://tailwindcss.com/">Tailwind</a></h2>
104-
<p>This data table is designed for viewing and editing data in an array of objects. It works in conjunction with the Flowbite Svelte library, with support for custom cell editors, moving focus between cells with tab and enter, column sorting (simple and custom), conditional CSS, and more.</p>
104+
<p>This data table is designed for viewing and editing data in an array of objects. It's built using the Flowbite Svelte library's Table components and works in conjunction with it, with support for custom cell editors, moving focus between cells with tab and enter, column sorting (simple and custom), conditional CSS, and more.</p>
105105
<h2>Install</h2>
106106
<p>To add to an existing Svelte app, first install Tailwind if you haven't already:</p>
107107
<pre class="prettyprint source lang-bash"><code>> npx svelte-add@latest tailwindcss
@@ -135,7 +135,19 @@ <h2>Basic example</h2>
135135
/>
136136
&lt;/main>
137137
</code></pre>
138-
<p>Examples for most of the component's features are under /examples . You can find the documentation <a href="https://emamid.github.io/svelte-data-table/">here</a>.</p></article>
138+
<p>Examples for most of the component's features are under /examples . You can find the documentation <a href="https://emamid.github.io/svelte-data-table/">here</a>.</p>
139+
<h4>Example 1 - Basic data table</h4>
140+
<p><img src="./screenshot-01.png" alt="Example 1"></p>
141+
<h4>Example 2 - Table with cell focus components</h4>
142+
<p><img src="./screenshot-02.png" alt="Example 2"></p>
143+
<h4>Example 3 - Table with cell focus Select components, cell renderers, and custom sort</h4>
144+
<p><img src="./screenshot-03.png" alt="Example 3"></p>
145+
<h4>Example 4 - Table with actions and cell view components</h4>
146+
<p><img src="./screenshot-04.png" alt="Example 4"></p>
147+
<h4>Example 5 - Table with custom cell component</h4>
148+
<p><img src="./screenshot-05.png" alt="Example 5"></p>
149+
<h4>Example 6 - Table with cell and row class getter functions</h4>
150+
<p><img src="./screenshot-06.png" alt="Example 6"></p></article>
139151
</section>
140152

141153

examples/03-selectcell-and-custom-sort/screenshot-03.png renamed to docs/screenshot-03.png

File renamed without changes.

examples/04-cellview-and-actions/screenshot-04.png renamed to docs/screenshot-04.png

File renamed without changes.
File renamed without changes.

examples/06-class-getters/screenshot-06.png renamed to docs/screenshot-06.png

File renamed without changes.

examples/01-basic/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Just the basic data table with columns and data items, no in-grid components or conditional/computed CSS.
44

5-
![](screenshot-01.png)
5+
![](../../screenshot-01.png)
66

77
## Installation
88

examples/02-cell-focus/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The Name column has an ```InputCell``` focus component, while the Fingers and Level columns have ```NumberInputCell``` focus components. Editing is implemented via the ```cellChanged``` event. All three columns are sortable.
44

5-
![](screenshot-02.png)
5+
![](../../screenshot-02.png)
66

77
## Installation
88

0 commit comments

Comments
 (0)