@cu-mkp/editioncrafter 1.0.3 → 1.0.4-beta.1

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 (57) hide show
  1. package/README.md +7 -7
  2. package/dist/editioncrafter.js +65802 -0
  3. package/dist/editioncrafter.umd.cjs +553 -0
  4. package/dist/es/src/action/DiplomaticActions.js +9 -11
  5. package/dist/es/src/action/DocumentActions.js +164 -154
  6. package/dist/es/src/action/GlossaryActions.js +9 -11
  7. package/dist/es/src/action/initialState/diplomaticInitialState.js +2 -2
  8. package/dist/es/src/action/initialState/documentInitialState.js +9 -12
  9. package/dist/es/src/action/initialState/glossaryInitialState.js +3 -3
  10. package/dist/es/src/action/rootReducer.js +31 -29
  11. package/dist/es/src/component/AlphabetLinks.js +44 -66
  12. package/dist/es/src/component/CustomizedTooltops.js +101 -110
  13. package/dist/es/src/component/DiploMatic.js +64 -91
  14. package/dist/es/src/component/DocumentView.js +442 -366
  15. package/dist/es/src/component/EditorComment.js +51 -75
  16. package/dist/es/src/component/ErrorBoundary.js +37 -61
  17. package/dist/es/src/component/FigureImage.js +56 -67
  18. package/dist/es/src/component/GlossaryView.js +157 -149
  19. package/dist/es/src/component/HelpPopper.js +96 -78
  20. package/dist/es/src/component/ImageGridView.js +184 -249
  21. package/dist/es/src/component/ImageView.js +155 -165
  22. package/dist/es/src/component/ImageZoomControl.js +19 -38
  23. package/dist/es/src/component/JumpToFolio.js +56 -60
  24. package/dist/es/src/component/Navigation.js +374 -328
  25. package/dist/es/src/component/Pagination.js +73 -70
  26. package/dist/es/src/component/Parser.js +11 -32
  27. package/dist/es/src/component/RingSpinner.js +31 -32
  28. package/dist/es/src/component/RouteListener.js +30 -21
  29. package/dist/es/src/component/SeaDragonComponent.js +33 -56
  30. package/dist/es/src/component/SinglePaneView.js +15 -33
  31. package/dist/es/src/component/SplitPaneView.js +151 -170
  32. package/dist/es/src/component/TranscriptionView.js +190 -179
  33. package/dist/es/src/component/Watermark.js +21 -30
  34. package/dist/es/src/component/XMLView.js +60 -82
  35. package/dist/es/src/hooks/useIsWidthUp.js +9 -7
  36. package/dist/es/src/icons/ByIcon.js +16 -16
  37. package/dist/es/src/icons/CcIcon.js +16 -16
  38. package/dist/es/src/icons/NcIcon.js +16 -16
  39. package/dist/es/src/icons/SaIcon.js +16 -16
  40. package/dist/es/src/icons/SideMenuIconLeft.js +30 -38
  41. package/dist/es/src/icons/SideMenuIconRight.js +32 -38
  42. package/dist/es/src/index.js +21 -20
  43. package/dist/es/src/lib/copyObject.js +3 -2
  44. package/dist/es/src/lib/registerServiceWorker.js +77 -54
  45. package/dist/es/src/model/DocumentHelper.js +7 -6
  46. package/dist/es/src/model/Folio.js +68 -146
  47. package/dist/es/src/model/ReduxStore.js +32 -78
  48. package/dist/es/src/model/folioLayout.js +275 -280
  49. package/dist/es/src/saga/RouteListenerSaga.js +89 -203
  50. package/dist/es/src/saga/rootSaga.js +9 -16
  51. package/dist/es/src/scss/_imageView.scss +1 -1
  52. package/dist/es/src/scss/_navigation.scss +1 -1
  53. package/dist/es/src/scss/editioncrafter.scss +1 -1
  54. package/dist/style.css +1 -0
  55. package/package.json +36 -50
  56. package/dist/editioncrafter.min.js +0 -2
  57. package/dist/editioncrafter.min.js.LICENSE.txt +0 -144
package/README.md CHANGED
@@ -19,13 +19,13 @@ The reference section below details all of the props of the EditionCrafter compo
19
19
  import EditionCrafter from '@cu-mkp/editioncrafter'
20
20
 
21
21
  <EditionCrafter
22
- documentName='BnF Ms. Fr. 640'
22
+ documentName="BnF Ms. Fr. 640"
23
23
  transcriptionTypes={{
24
24
  tc: 'Diplomatic (FR)',
25
25
  tcn: 'Normalized (FR)',
26
26
  tl: 'Translation (EN)'
27
27
  }}
28
- iiifManifest='https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/iiif/manifest.json'
28
+ iiifManifest="https://cu-mkp.github.io/editioncrafter-data/fr640_3r-3v-example/iiif/manifest.json"
29
29
  />
30
30
  ```
31
31
 
@@ -60,7 +60,7 @@ The following props are available to the `<EditionCrafter>` viewer component:
60
60
 
61
61
  ### documentInfo
62
62
 
63
- Optional; used **only** in the case that you wish to load multiple documents in the same viewer for easy comparison.
63
+ Optional; used **only** in the case that you wish to load multiple documents in the same viewer for easy comparison.
64
64
 
65
65
  An *object* whose keys are unique document IDs for each document you wish to include, and whose values are *objects* specifying the `documentName`, `transcriptionTypes`, and `iiifManifest` for each document as described below. For example:
66
66
  ```js
@@ -71,7 +71,7 @@ documentInfo={{
71
71
  translation: 'Translation',
72
72
  transcription: 'Transcription',
73
73
  },
74
- iiifManifest: 'https://cu-mkp.github.io/editioncrafter/taos-baptisms-example/iiif/manifest.json',
74
+ iiifManifest: 'https://editioncrafter.org/taos-baptisms-example/iiif/manifest.json',
75
75
  },
76
76
  eng_415_145a: {
77
77
  documentName: 'Eng 415-145a',
@@ -87,7 +87,7 @@ documentInfo={{
87
87
 
88
88
  Required. (Note: This is required even in the case that you have also included a `documentInfo` prop.)
89
89
 
90
- A *string* giving the name of the document(s).
90
+ A *string* giving the name of the document(s).
91
91
 
92
92
  ### iiifManifest
93
93
 
@@ -124,8 +124,8 @@ In this case the `transcriptionTypes` object might have the form:
124
124
 
125
125
  ```js
126
126
  transcriptionTypes = {
127
- transcription: 'Transcription',
128
- translation: 'Translation'
127
+ transcription: 'Transcription',
128
+ translation: 'Translation'
129
129
  }
130
130
  ```
131
131
  The value for each transcription type should be a string that will be displayed in the selection menu within the viewer. These need not correspond precisely to the keys. For instance in the example above, you could add more information to the display strings, e.g. `'Transcription (FR)'` and `Translation (EN)`.