@docling/docling-components 0.0.7 → 0.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -13
- package/dist/index.cjs +2840 -0
- package/dist/index.d.cts +180 -0
- package/dist/index.d.ts +180 -0
- package/dist/index.js +2796 -0
- package/package.json +59 -22
- package/dist/index.es.js +0 -1885
- package/dist/index.umd.js +0 -487
package/README.md
CHANGED
|
@@ -24,7 +24,10 @@ Either download the package and serve it as part of the rest of the website, or
|
|
|
24
24
|
<head>
|
|
25
25
|
...
|
|
26
26
|
|
|
27
|
-
<script
|
|
27
|
+
<script
|
|
28
|
+
type="module"
|
|
29
|
+
src="https://unpkg.com/@docling/docling-components/dist/index.es.js"
|
|
30
|
+
/>
|
|
28
31
|
</head>
|
|
29
32
|
|
|
30
33
|
...
|
|
@@ -147,10 +150,7 @@ Select the columns that you want to have shown and in what order:
|
|
|
147
150
|
You can use this to display the cropped image of a single document item as well:
|
|
148
151
|
|
|
149
152
|
```html
|
|
150
|
-
<docling-table
|
|
151
|
-
src="conversion.json"
|
|
152
|
-
items="#/tables/2"
|
|
153
|
-
>
|
|
153
|
+
<docling-table src="conversion.json" items="#/tables/2">
|
|
154
154
|
<docling-column>
|
|
155
155
|
<docling-item-provenance></docling-item-provenance>
|
|
156
156
|
</docling-column>
|
|
@@ -158,13 +158,16 @@ You can use this to display the cropped image of a single document item as well:
|
|
|
158
158
|
```
|
|
159
159
|
|
|
160
160
|
## Item components
|
|
161
|
+
|
|
161
162
|
Most types of document item have a prepackaged component that will be used to visualize it:
|
|
162
|
-
|
|
163
|
-
|
|
|
164
|
-
|
|
|
165
|
-
| `<docling-item-
|
|
163
|
+
|
|
164
|
+
| Tag | Item label |
|
|
165
|
+
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
166
|
+
| `<docling-item-text>` | checkbox_selected<br /> checkbox_unselected<br /> footnote<br /> page_footer<br /> page_header<br /> paragraph<br /> text<br /> reference |
|
|
167
|
+
| `<docling-item-table>` | table |
|
|
166
168
|
|
|
167
169
|
You can use these tags directly with elements like `<docling-tooltip>` to specify what components will be used, including optional parameters. For example, to exclusively show tooltips for table components:
|
|
170
|
+
|
|
168
171
|
```
|
|
169
172
|
<docling-tooltip>
|
|
170
173
|
<docling-item-table></docling-item-table>
|
|
@@ -174,13 +177,16 @@ You can use these tags directly with elements like `<docling-tooltip>` to specif
|
|
|
174
177
|
You can create your own item components by extending from the `DoclingItemElement` class at `/src/item/ItemElement.ts` and annotating the class with `@customDoclingItemElement('docling-my-first-item-component')` to have it registered as both a custom web element and as a default component for rendering document items.
|
|
175
178
|
|
|
176
179
|
## Annotation components
|
|
180
|
+
|
|
177
181
|
Some types of document item annotation have a prepackaged component that will be used to visualize it:
|
|
178
|
-
|
|
179
|
-
|
|
|
180
|
-
|
|
|
181
|
-
| `<docling-picture-
|
|
182
|
+
|
|
183
|
+
| Tag | Item label | Annotation kind |
|
|
184
|
+
| ---------------------------------- | -------------------- | --------------- |
|
|
185
|
+
| `<docling-picture-classification>` | chart <br /> picture | classification |
|
|
186
|
+
| `<docling-picture-description>` | chart <br /> picture | description |
|
|
182
187
|
|
|
183
188
|
You can use these tags directly with elements like `<docling-tooltip>` to specify what components will be used. For example, to overlay pictures with their classification, if any:
|
|
189
|
+
|
|
184
190
|
```
|
|
185
191
|
<docling-overlay>
|
|
186
192
|
<docling-picture-classification></docling-picture-classification>
|