@pdfme/ui 1.0.0-beta.1 → 1.0.0-beta.6

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.
Files changed (67) hide show
  1. package/README.md +8 -7
  2. package/dist/index.js +3 -0
  3. package/dist/{@pdfme/ui.js.LICENSE.txt → index.js.LICENSE.txt} +3 -1
  4. package/dist/index.js.map +1 -0
  5. package/dist/types/{ui/src/Designer.d.ts → Designer.d.ts} +0 -0
  6. package/dist/types/{ui/src/Form.d.ts → Form.d.ts} +0 -0
  7. package/dist/types/{ui/src/Viewer.d.ts → Viewer.d.ts} +0 -0
  8. package/dist/types/{ui/src/libs/class.d.ts → class.d.ts} +7 -19
  9. package/dist/types/{ui/src/components → components}/Designer/Main/Guides.d.ts +0 -0
  10. package/dist/types/{ui/src/components → components}/Designer/Main/Mask.d.ts +0 -0
  11. package/dist/types/{ui/src/components → components}/Designer/Main/Moveable.d.ts +0 -0
  12. package/dist/types/{ui/src/components → components}/Designer/Main/Selecto.d.ts +0 -0
  13. package/dist/types/{ui/src/components → components}/Designer/Main/index.d.ts +0 -0
  14. package/dist/types/{ui/src/components → components}/Designer/Sidebar/DetailView/ExampleInputEditor.d.ts +0 -0
  15. package/dist/types/{ui/src/components → components}/Designer/Sidebar/DetailView/PositionAndSizeEditor.d.ts +0 -0
  16. package/dist/types/{ui/src/components → components}/Designer/Sidebar/DetailView/TextPropEditor.d.ts +0 -0
  17. package/dist/types/{ui/src/components → components}/Designer/Sidebar/DetailView/TypeAndKeyEditor.d.ts +0 -0
  18. package/dist/types/{ui/src/components → components}/Designer/Sidebar/DetailView/index.d.ts +0 -0
  19. package/dist/types/{ui/src/components → components}/Designer/Sidebar/ListView.d.ts +0 -0
  20. package/dist/types/{ui/src/components → components}/Designer/Sidebar/index.d.ts +0 -1
  21. package/dist/types/{ui/src/components → components}/Designer/index.d.ts +0 -1
  22. package/dist/types/{ui/src/components → components}/Divider.d.ts +0 -0
  23. package/dist/types/{ui/src/components → components}/Error.d.ts +0 -1
  24. package/dist/types/{ui/src/components → components}/Paper.d.ts +0 -0
  25. package/dist/types/{ui/src/components → components}/Preview/Pager/Page.d.ts +0 -1
  26. package/dist/types/{ui/src/components → components}/Preview/Pager/Unit.d.ts +0 -1
  27. package/dist/types/{ui/src/components → components}/Preview/index.d.ts +0 -1
  28. package/dist/types/{ui/src/components → components}/Root.d.ts +0 -0
  29. package/dist/types/{ui/src/components → components}/Schemas/BarcodeSchema.d.ts +0 -0
  30. package/dist/types/{ui/src/components → components}/Schemas/ImageSchema.d.ts +0 -0
  31. package/dist/types/{ui/src/components → components}/Schemas/SchemaUI.d.ts +1 -1
  32. package/dist/types/{ui/src/components → components}/Schemas/TextSchema.d.ts +0 -0
  33. package/dist/types/{ui/src/components → components}/Spinner.d.ts +0 -0
  34. package/dist/types/{ui/src/constants.d.ts → constants.d.ts} +0 -0
  35. package/dist/types/{ui/src/libs/contexts.d.ts → contexts.d.ts} +0 -0
  36. package/dist/types/{ui/src/helper.d.ts → helper.d.ts} +0 -0
  37. package/dist/types/{ui/src/hooks.d.ts → hooks.d.ts} +0 -0
  38. package/dist/types/{ui/src/i18n.d.ts → i18n.d.ts} +0 -0
  39. package/dist/types/index.d.ts +6 -0
  40. package/package.json +9 -6
  41. package/src/helper.ts +1 -1
  42. package/src/index.ts +5 -41
  43. package/tsconfig.json +1 -0
  44. package/webpack.config.js +1 -2
  45. package/dist/@pdfme/ui.js +0 -3
  46. package/dist/@pdfme/ui.js.map +0 -1
  47. package/dist/types/common/src/barcode.d.ts +0 -2
  48. package/dist/types/common/src/constants.d.ts +0 -6
  49. package/dist/types/common/src/helper.d.ts +0 -15
  50. package/dist/types/common/src/index.d.ts +0 -4
  51. package/dist/types/common/src/schema.d.ts +0 -3613
  52. package/dist/types/common/src/type.d.ts +0 -64
  53. package/dist/types/common/src/utils.d.ts +0 -12
  54. package/dist/types/ui/src/class.d.ts +0 -72
  55. package/dist/types/ui/src/contexts.d.ts +0 -7
  56. package/dist/types/ui/src/index.d.ts +0 -5
  57. package/dist/types/ui/src/libs/helper.d.ts +0 -64
  58. package/dist/types/ui/src/libs/hooks.d.ts +0 -26
  59. package/dist/types/ui/src/libs/i18n.d.ts +0 -30
  60. package/dist/types/ui/src/libs/ui.d.ts +0 -64
  61. package/public/Designer.html +0 -90
  62. package/public/Form.html +0 -74
  63. package/public/SauceHanSansJP.ttf +0 -0
  64. package/public/SauceHanSerifJP.ttf +0 -0
  65. package/public/Viewer.html +0 -73
  66. package/public/helper.js +0 -51
  67. package/public/index.html +0 -54
package/README.md CHANGED
@@ -5,8 +5,9 @@
5
5
  TypeScript base PDF generator and React base UI.
6
6
  Open source, developed by the community, and completely free to use under the MIT license!
7
7
 
8
- ![](/website/static/img/logo.svg)
9
-
8
+ <p align="center">
9
+ <img src="https://raw.githubusercontent.com/pdfme/pdfme/main/website/static/img/logo.svg" width="300"/>
10
+ </p>
10
11
 
11
12
  ## Features
12
13
 
@@ -85,7 +86,7 @@ A template can be divided into two parts: a fixed part and a variable part.
85
86
  We call them basePdf and schema.
86
87
  The following image is a good illustration of a template.
87
88
 
88
- ![](/website/static/img/template.png)
89
+ ![](https://raw.githubusercontent.com/pdfme/pdfme/main/website/static/img/template.png)
89
90
 
90
91
  - **basePdf**: PDF data for the fixed part of the PDF to be generated.
91
92
  - **schemas**: Definition data for the variable part of the PDF to be generated.
@@ -167,7 +168,7 @@ generate({ template, inputs }).then((pdf) => {
167
168
 
168
169
  You can create a PDF file like the below.
169
170
 
170
- ![](/website/static/img/simplePdf.png)
171
+ ![](https://raw.githubusercontent.com/pdfme/pdfme/main/website/static/img/simplePdf.png)
171
172
 
172
173
  Also, each element in the inputs array corresponds to a page in the PDF, you can create a multi-page PDF file by providing multiple elements of inputs.
173
174
 
@@ -197,7 +198,7 @@ const designer = new Designer({ domContainer, template });
197
198
  The Designer class is instantiated as shown above, and the template designer is displayed in the `domContainer`.
198
199
  You can edit the template as shown below. The operation is like Google Slides, etc., so you can use common keyboard shortcuts.
199
200
 
200
- ![](/website/static/img/designer.gif)
201
+ ![](https://raw.githubusercontent.com/pdfme/pdfme/main/website/static/img/designer.gif)
201
202
 
202
203
  The designer instance can be manipulated with the following methods.
203
204
 
@@ -229,7 +230,7 @@ const inputs = [{ a: 'a1', b: 'b1', c: 'c1' }];
229
230
  const form = new Form({ domContainer, template, inputs });
230
231
  ```
231
232
 
232
- ![](/website/static/img/form.gif)
233
+ ![](https://raw.githubusercontent.com/pdfme/pdfme/main/website/static/img/form.gif)
233
234
 
234
235
  The form instance has a method `getInputs` to get the user's input.
235
236
 
@@ -264,7 +265,7 @@ const inputs = [{ a: 'a1', b: 'b1', c: 'c1' }];
264
265
  const viewer = new Viewer({ domContainer, template, inputs });
265
266
  ```
266
267
 
267
- ![](/website/static/img/viewer.png)
268
+ ![](https://raw.githubusercontent.com/pdfme/pdfme/main/website/static/img/viewer.png)
268
269
 
269
270
  [For more information, please refer to the API documentation of the Viewer class here](https://pdfme.com/docs/api/ui/classes/Viewer).
270
271