@hmlr/govuk-react-components-library 1.0.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 (203) hide show
  1. package/.nvmrc +1 -0
  2. package/.stylelintrc.json +8 -0
  3. package/LICENCE +21 -0
  4. package/README.md +636 -0
  5. package/assets/Advance-submodule-behaviours.png +0 -0
  6. package/assets/logo.png +0 -0
  7. package/assets/uml-diagram.svg +2541 -0
  8. package/bundle-analysis-main.html +4951 -0
  9. package/bundle-analysis-pdfvc.html +4949 -0
  10. package/dist/PDFViewerCanvas.cjs.css +86 -0
  11. package/dist/PDFViewerCanvas.cjs.js +243 -0
  12. package/dist/PDFViewerCanvas.cjs.js.map +1 -0
  13. package/dist/PDFViewerCanvas.d.ts +19 -0
  14. package/dist/PDFViewerCanvas.esm.css +86 -0
  15. package/dist/PDFViewerCanvas.esm.js +241 -0
  16. package/dist/PDFViewerCanvas.esm.js.map +1 -0
  17. package/dist/index.cjs.css +11962 -0
  18. package/dist/index.cjs.js +1362 -0
  19. package/dist/index.cjs.js.map +1 -0
  20. package/dist/index.d.ts +743 -0
  21. package/dist/index.esm.css +11962 -0
  22. package/dist/index.esm.js +1284 -0
  23. package/dist/index.esm.js.map +1 -0
  24. package/dist/types/JestSetup.d.ts +1 -0
  25. package/dist/types/PDFViewerCanvas.d.ts +1 -0
  26. package/dist/types/components/Accordion/Accordion.config.d.ts +5 -0
  27. package/dist/types/components/Accordion/Accordion.d.ts +4 -0
  28. package/dist/types/components/Accordion/Accordion.types.d.ts +20 -0
  29. package/dist/types/components/Accordion/index.d.ts +2 -0
  30. package/dist/types/components/ActionLink/ActionLink.d.ts +4 -0
  31. package/dist/types/components/ActionLink/ActionLink.types.d.ts +13 -0
  32. package/dist/types/components/ActionLink/index.d.ts +1 -0
  33. package/dist/types/components/BackLink/BackLink.d.ts +4 -0
  34. package/dist/types/components/BackLink/BackLink.types.d.ts +9 -0
  35. package/dist/types/components/BackLink/index.d.ts +1 -0
  36. package/dist/types/components/Boolean/Boolean.d.ts +4 -0
  37. package/dist/types/components/Boolean/Boolean.types.d.ts +39 -0
  38. package/dist/types/components/Boolean/OmitKey.d.ts +5 -0
  39. package/dist/types/components/Boolean/index.d.ts +1 -0
  40. package/dist/types/components/Breadcrumbs/Breadcrumbs.d.ts +4 -0
  41. package/dist/types/components/Breadcrumbs/Breadcrumbs.types.d.ts +13 -0
  42. package/dist/types/components/Breadcrumbs/index.d.ts +1 -0
  43. package/dist/types/components/Button/Button.config.d.ts +2 -0
  44. package/dist/types/components/Button/Button.d.ts +4 -0
  45. package/dist/types/components/Button/Button.types.d.ts +13 -0
  46. package/dist/types/components/Button/index.d.ts +2 -0
  47. package/dist/types/components/CardColumn/CardColumn.d.ts +5 -0
  48. package/dist/types/components/CardColumn/CardColumn.types.d.ts +5 -0
  49. package/dist/types/components/CardColumn/index.d.ts +1 -0
  50. package/dist/types/components/CardLayout/CardLayout.d.ts +4 -0
  51. package/dist/types/components/CardLayout/CardLayout.types.d.ts +5 -0
  52. package/dist/types/components/CardLayout/index.d.ts +1 -0
  53. package/dist/types/components/CharacterCount/CharacterCount.config.d.ts +2 -0
  54. package/dist/types/components/CharacterCount/CharacterCount.d.ts +4 -0
  55. package/dist/types/components/CharacterCount/CharacterCount.types.d.ts +12 -0
  56. package/dist/types/components/CharacterCount/index.d.ts +1 -0
  57. package/dist/types/components/Checkboxes/Checkboxes.config.d.ts +1 -0
  58. package/dist/types/components/Checkboxes/Checkboxes.d.ts +4 -0
  59. package/dist/types/components/Checkboxes/Checkboxes.types.d.ts +3 -0
  60. package/dist/types/components/Checkboxes/index.d.ts +2 -0
  61. package/dist/types/components/CookieBanner/CookieBanner.d.ts +4 -0
  62. package/dist/types/components/CookieBanner/CookieBanner.types.d.ts +21 -0
  63. package/dist/types/components/CookieBanner/index.d.ts +1 -0
  64. package/dist/types/components/DataNavigation/DataNavigation.d.ts +4 -0
  65. package/dist/types/components/DataNavigation/DataNavigation.types.d.ts +9 -0
  66. package/dist/types/components/DataNavigation/index.d.ts +1 -0
  67. package/dist/types/components/DateInput/DateInput.d.ts +4 -0
  68. package/dist/types/components/DateInput/DateInput.types.d.ts +29 -0
  69. package/dist/types/components/DateInput/index.d.ts +1 -0
  70. package/dist/types/components/Details/Details.d.ts +4 -0
  71. package/dist/types/components/Details/Details.types.d.ts +5 -0
  72. package/dist/types/components/Details/index.d.ts +1 -0
  73. package/dist/types/components/DifferenceNavigation/DifferenceNavigation.d.ts +4 -0
  74. package/dist/types/components/DifferenceNavigation/DifferenceNavigation.types.d.ts +7 -0
  75. package/dist/types/components/DifferenceNavigation/index.d.ts +1 -0
  76. package/dist/types/components/ErrorBoundary/ErrorBoundary.d.ts +9 -0
  77. package/dist/types/components/ErrorBoundary/ErrorBoundary.types.d.ts +11 -0
  78. package/dist/types/components/ErrorBoundary/index.d.ts +1 -0
  79. package/dist/types/components/ErrorMessage/ErrorMessage.d.ts +4 -0
  80. package/dist/types/components/ErrorMessage/ErrorMessage.types.d.ts +6 -0
  81. package/dist/types/components/ErrorMessage/index.d.ts +1 -0
  82. package/dist/types/components/ErrorSummary/ErrorSummary.config.d.ts +2 -0
  83. package/dist/types/components/ErrorSummary/ErrorSummary.d.ts +4 -0
  84. package/dist/types/components/ErrorSummary/ErrorSummary.types.d.ts +13 -0
  85. package/dist/types/components/ErrorSummary/index.d.ts +2 -0
  86. package/dist/types/components/Fieldset/Fieldset.d.ts +4 -0
  87. package/dist/types/components/Fieldset/Fieldset.types.d.ts +12 -0
  88. package/dist/types/components/Fieldset/index.d.ts +1 -0
  89. package/dist/types/components/FileUpload/FileUpload.d.ts +4 -0
  90. package/dist/types/components/FileUpload/FileUpload.types.d.ts +15 -0
  91. package/dist/types/components/FileUpload/index.d.ts +1 -0
  92. package/dist/types/components/Footer/Footer.d.ts +4 -0
  93. package/dist/types/components/Footer/Footer.types.d.ts +33 -0
  94. package/dist/types/components/Footer/index.d.ts +1 -0
  95. package/dist/types/components/Header/Header.config.d.ts +1 -0
  96. package/dist/types/components/Header/Header.d.ts +4 -0
  97. package/dist/types/components/Header/Header.types.d.ts +28 -0
  98. package/dist/types/components/Header/index.d.ts +2 -0
  99. package/dist/types/components/Hint/Hint.d.ts +4 -0
  100. package/dist/types/components/Hint/Hint.types.d.ts +4 -0
  101. package/dist/types/components/Hint/index.d.ts +1 -0
  102. package/dist/types/components/Input/Input.d.ts +4 -0
  103. package/dist/types/components/Input/Input.types.d.ts +22 -0
  104. package/dist/types/components/Input/index.d.ts +1 -0
  105. package/dist/types/components/InsetText/InsetText.d.ts +4 -0
  106. package/dist/types/components/InsetText/InsetText.types.d.ts +4 -0
  107. package/dist/types/components/InsetText/index.d.ts +1 -0
  108. package/dist/types/components/Label/Label.d.ts +4 -0
  109. package/dist/types/components/Label/Label.types.d.ts +6 -0
  110. package/dist/types/components/Label/index.d.ts +1 -0
  111. package/dist/types/components/Landing/Landing.d.ts +4 -0
  112. package/dist/types/components/Landing/Landing.types.d.ts +4 -0
  113. package/dist/types/components/Landing/index.d.ts +1 -0
  114. package/dist/types/components/LinkWithRef/LinkWithRef.d.ts +4 -0
  115. package/dist/types/components/LinkWithRef/LinkWithRef.types.d.ts +9 -0
  116. package/dist/types/components/LinkWithRef/index.d.ts +1 -0
  117. package/dist/types/components/Loading/Loading.d.ts +5 -0
  118. package/dist/types/components/Loading/Loading.types.d.ts +4 -0
  119. package/dist/types/components/Loading/index.d.ts +1 -0
  120. package/dist/types/components/Main/Main.d.ts +4 -0
  121. package/dist/types/components/Main/Main.types.d.ts +5 -0
  122. package/dist/types/components/Main/index.d.ts +1 -0
  123. package/dist/types/components/NotFoundPage/NotFoundPage.d.ts +3 -0
  124. package/dist/types/components/NotFoundPage/index.d.ts +1 -0
  125. package/dist/types/components/NotificationBanner/NotificationBanner.config.d.ts +2 -0
  126. package/dist/types/components/NotificationBanner/NotificationBanner.d.ts +4 -0
  127. package/dist/types/components/NotificationBanner/NotificationBanner.types.d.ts +12 -0
  128. package/dist/types/components/NotificationBanner/index.d.ts +1 -0
  129. package/dist/types/components/PDFViewer/ObjectToQueryString.d.ts +1 -0
  130. package/dist/types/components/PDFViewer/PDFViewer.d.ts +4 -0
  131. package/dist/types/components/PDFViewer/PDFViewer.types.d.ts +25 -0
  132. package/dist/types/components/PDFViewer/PDFViewerBackend.d.ts +2 -0
  133. package/dist/types/components/PDFViewer/ResolvePDFSource.d.ts +4 -0
  134. package/dist/types/components/PDFViewer/Slugify.d.ts +1 -0
  135. package/dist/types/components/PDFViewer/index.d.ts +2 -0
  136. package/dist/types/components/PDFViewer/testutilities/SampleBase64.d.ts +44 -0
  137. package/dist/types/components/PDFViewerCanvas/PDFViewerCanvas.d.ts +9 -0
  138. package/dist/types/components/PDFViewerCanvas/PDFViewerCanvas.types.d.ts +8 -0
  139. package/dist/types/components/PDFViewerCanvas/index.d.ts +1 -0
  140. package/dist/types/components/Pagination/NavigationButton.d.ts +3 -0
  141. package/dist/types/components/Pagination/Pagination.d.ts +4 -0
  142. package/dist/types/components/Pagination/Pagination.types.d.ts +22 -0
  143. package/dist/types/components/Pagination/SvgIcon.d.ts +3 -0
  144. package/dist/types/components/Pagination/UsePagination.d.ts +9 -0
  145. package/dist/types/components/Pagination/index.d.ts +1 -0
  146. package/dist/types/components/Panel/Panel.d.ts +4 -0
  147. package/dist/types/components/Panel/Panel.types.d.ts +7 -0
  148. package/dist/types/components/Panel/index.d.ts +1 -0
  149. package/dist/types/components/PhaseBanner/PhaseBanner.d.ts +4 -0
  150. package/dist/types/components/PhaseBanner/PhaseBanner.types.d.ts +6 -0
  151. package/dist/types/components/PhaseBanner/index.d.ts +1 -0
  152. package/dist/types/components/ProblemWithService/ProblemWithService.d.ts +4 -0
  153. package/dist/types/components/ProblemWithService/ProblemWithService.types.d.ts +7 -0
  154. package/dist/types/components/ProblemWithService/index.d.ts +1 -0
  155. package/dist/types/components/Radios/Radios.config.d.ts +1 -0
  156. package/dist/types/components/Radios/Radios.d.ts +4 -0
  157. package/dist/types/components/Radios/Radios.types.d.ts +7 -0
  158. package/dist/types/components/Radios/index.d.ts +2 -0
  159. package/dist/types/components/Select/Select.d.ts +4 -0
  160. package/dist/types/components/Select/Select.types.d.ts +21 -0
  161. package/dist/types/components/Select/index.d.ts +1 -0
  162. package/dist/types/components/ServiceNavigation/ServiceNavigation.d.ts +4 -0
  163. package/dist/types/components/ServiceNavigation/ServiceNavigation.types.d.ts +21 -0
  164. package/dist/types/components/ServiceNavigation/index.d.ts +1 -0
  165. package/dist/types/components/SkipLink/SkipLink.config.d.ts +1 -0
  166. package/dist/types/components/SkipLink/SkipLink.d.ts +4 -0
  167. package/dist/types/components/SkipLink/SkipLink.types.d.ts +5 -0
  168. package/dist/types/components/SkipLink/index.d.ts +2 -0
  169. package/dist/types/components/SummaryList/SummaryList.d.ts +4 -0
  170. package/dist/types/components/SummaryList/SummaryList.types.d.ts +22 -0
  171. package/dist/types/components/SummaryList/index.d.ts +1 -0
  172. package/dist/types/components/Table/Table.d.ts +4 -0
  173. package/dist/types/components/Table/Table.types.d.ts +21 -0
  174. package/dist/types/components/Table/index.d.ts +1 -0
  175. package/dist/types/components/Tabs/Tabs.config.d.ts +1 -0
  176. package/dist/types/components/Tabs/Tabs.d.ts +4 -0
  177. package/dist/types/components/Tabs/Tabs.types.d.ts +14 -0
  178. package/dist/types/components/Tabs/index.d.ts +2 -0
  179. package/dist/types/components/Tag/Tag.d.ts +4 -0
  180. package/dist/types/components/Tag/Tag.types.d.ts +4 -0
  181. package/dist/types/components/Tag/index.d.ts +1 -0
  182. package/dist/types/components/TaskList/TaskList.d.ts +4 -0
  183. package/dist/types/components/TaskList/TaskList.types.d.ts +21 -0
  184. package/dist/types/components/TaskList/index.d.ts +1 -0
  185. package/dist/types/components/Textarea/Textarea.d.ts +4 -0
  186. package/dist/types/components/Textarea/Textarea.types.d.ts +14 -0
  187. package/dist/types/components/Textarea/index.d.ts +1 -0
  188. package/dist/types/components/WarningInfo/WarningInfo.d.ts +4 -0
  189. package/dist/types/components/WarningInfo/WarningInfo.types.d.ts +8 -0
  190. package/dist/types/components/WarningInfo/index.d.ts +1 -0
  191. package/dist/types/components/WarningText/WarningText.d.ts +4 -0
  192. package/dist/types/components/WarningText/WarningText.types.d.ts +4 -0
  193. package/dist/types/components/WarningText/index.d.ts +1 -0
  194. package/dist/types/components/index.d.ts +49 -0
  195. package/dist/types/dynamics/index.d.ts +3 -0
  196. package/dist/types/dynamics/types.d.ts +37 -0
  197. package/dist/types/index.d.ts +1 -0
  198. package/dist/types/utils/ProcessExampleData.d.ts +3 -0
  199. package/dist/types/utils/StoriesFromFixtures.d.ts +5 -0
  200. package/dist/types/utils/TitleCase.d.ts +2 -0
  201. package/dist/types/utils/WithReference.d.ts +5 -0
  202. package/dist/types/utils/WithReference.types.d.ts +10 -0
  203. package/package.json +180 -0
package/package.json ADDED
@@ -0,0 +1,180 @@
1
+ {
2
+ "name": "@hmlr/govuk-react-components-library",
3
+ "version": "1.0.1",
4
+ "description": "These are common component use for React applications based on GDS and govuk-frontend",
5
+ "main": "dist/index.cjs.js",
6
+ "module": "dist/index.esm.js",
7
+ "types": "dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "import": "./dist/index.esm.js",
11
+ "require": "./dist/index.cjs.js"
12
+ },
13
+ "./PDFViewerCanvas": {
14
+ "import": "./dist/PDFViewerCanvas.esm.js",
15
+ "require": "./dist/PDFViewerCanvas.cjs.js"
16
+ }
17
+ },
18
+ "scripts": {
19
+ "clean": "rimraf dist",
20
+ "build": "npm run clean && rollup -c --bundleConfigAsCjs",
21
+ "prepublishOnly": "npm run build",
22
+ "dev": "rollup -c -w",
23
+ "test": "jest --collect-coverage",
24
+ "storybook": "storybook dev -p 6006",
25
+ "build-storybook": "storybook build",
26
+ "test-storybook": "test-storybook",
27
+ "lint": "eslint 'src/**/*.ts*' && stylelint 'src/**/*.{css,scss,less}'",
28
+ "lint-fix": "eslint --fix 'src/**/*.ts*' && stylelint --fix 'src/**/*.{css,scss,less}' ",
29
+ "format": "prettier --ignore-path .gitignore --write '**/*.+(js|mjs|ts|tsx|json|css|scss|html|md)'",
30
+ "prepare": "husky",
31
+ "release": "standard-version",
32
+ "uml": "tsuml2 --glob './src/**/\\!(*.spec|*.test|TestUtilities|JestSetup).[t]s?(x)' -o './assets/uml-diagram.svg'"
33
+ },
34
+ "repository": {
35
+ "type": "git",
36
+ "url": "https://github.com/LandRegistry/govuk-react-components-library"
37
+ },
38
+ "bugs": {
39
+ "url": "https://github.com/LandRegistry/govuk-react-components-library/issues"
40
+ },
41
+ "homepage": "https://github.com/LandRegistry/govuk-react-components-library#readme",
42
+ "keywords": [
43
+ "GDS",
44
+ "govuk",
45
+ "govuk-frontend",
46
+ "React",
47
+ "UI",
48
+ "Components"
49
+ ],
50
+ "author": "Cyril Adelekan",
51
+ "license": "MIT",
52
+ "devDependencies": {
53
+ "@babel/core": "^7.26.10",
54
+ "@babel/preset-env": "^7.26.9",
55
+ "@babel/preset-react": "^7.26.3",
56
+ "@babel/preset-typescript": "^7.26.0",
57
+ "@chromatic-com/storybook": "^3.2.6",
58
+ "@commitlint/cli": "^19.8.0",
59
+ "@commitlint/config-conventional": "^19.8.0",
60
+ "@eslint/js": "^9.22.0",
61
+ "@jest/globals": "^29.7.0",
62
+ "@rollup/plugin-commonjs": "^28.0.3",
63
+ "@rollup/plugin-json": "^6.1.0",
64
+ "@rollup/plugin-node-resolve": "^16.0.1",
65
+ "@rollup/plugin-terser": "^0.4.4",
66
+ "@rollup/plugin-typescript": "^11.1.6",
67
+ "@storybook/addon-a11y": "^8.6.7",
68
+ "@storybook/addon-actions": "^8.6.7",
69
+ "@storybook/addon-essentials": "^8.6.7",
70
+ "@storybook/addon-interactions": "^8.6.7",
71
+ "@storybook/addon-links": "^8.6.7",
72
+ "@storybook/addon-styling-webpack": "^1.0.1",
73
+ "@storybook/addon-webpack5-compiler-swc": "^2.1.0",
74
+ "@storybook/blocks": "^8.6.7",
75
+ "@storybook/core-common": "^8.6.7",
76
+ "@storybook/csf": "^0.1.13",
77
+ "@storybook/csf-tools": "^8.6.7",
78
+ "@storybook/react": "^8.6.7",
79
+ "@storybook/react-vite": "^8.6.7",
80
+ "@storybook/react-webpack5": "^8.6.7",
81
+ "@storybook/test": "^8.6.7",
82
+ "@storybook/test-runner": "^0.22.0",
83
+ "@storybook/types": "^8.6.7",
84
+ "@testing-library/jest-dom": "^6.6.3",
85
+ "@testing-library/react": "^16.2.0",
86
+ "@types/govuk-frontend": "^5.8.0",
87
+ "@types/jest": "^29.5.14",
88
+ "@types/react": "^19.0.11",
89
+ "@types/react-dom": "^19.0.4",
90
+ "@typescript-eslint/eslint-plugin": "^8.26.1",
91
+ "@typescript-eslint/parser": "^8.26.1",
92
+ "assert": "^2.1.0",
93
+ "autoprefixer": "^10.4.21",
94
+ "babel-jest": "^29.7.0",
95
+ "bootstrap": "^5.3.3",
96
+ "css-loader": "^7.1.2",
97
+ "deep-iterator": "^1.1.0",
98
+ "eslint": "^9.22.0",
99
+ "eslint-plugin-react": "^7.37.4",
100
+ "eslint-plugin-storybook": "^0.11.3",
101
+ "globals": "^16.0.0",
102
+ "govuk-frontend": "^5.9.0",
103
+ "html-react-parser": "^5.2.2",
104
+ "husky": "^9.1.7",
105
+ "identity-obj-proxy": "^3.0.0",
106
+ "jest": "^29.7.0",
107
+ "jest-environment-jsdom": "^29.7.0",
108
+ "magicast": "^0.3.5",
109
+ "pdfjs-dist": "^4.10.38",
110
+ "postcss": "^8.5.3",
111
+ "prettier": "^3.5.3",
112
+ "react": "^19.0.0",
113
+ "react-bootstrap": "^2.10.9",
114
+ "react-dom": "^19.0.0",
115
+ "react-element-to-jsx-string": "^17.0.0",
116
+ "react-router": "^7.3.0",
117
+ "react-router-dom": "^7.3.0",
118
+ "rimraf": "^6.0.1",
119
+ "rollup": "^4.36.0",
120
+ "rollup-plugin-analyzer": "^4.0.0",
121
+ "rollup-plugin-dts": "^6.1.1",
122
+ "rollup-plugin-peer-deps-external": "^2.2.4",
123
+ "rollup-plugin-postcss": "^4.0.2",
124
+ "rollup-plugin-visualizer": "^5.14.0",
125
+ "sass": "^1.86.0",
126
+ "sass-loader": "^16.0.5",
127
+ "standard-version": "^9.5.0",
128
+ "storybook": "^8.6.7",
129
+ "style-loader": "^4.0.0",
130
+ "stylelint": "^16.16.0",
131
+ "stylelint-config-idiomatic-order": "^10.0.0",
132
+ "stylelint-config-standard": "^37.0.0",
133
+ "stylelint-config-standard-scss": "^14.0.0",
134
+ "stylelint-order": "^6.0.4",
135
+ "tslib": "^2.8.1",
136
+ "tsuml2": "^0.17.1",
137
+ "typescript": "^5.8.2",
138
+ "typescript-eslint": "^8.26.1",
139
+ "unplugin": "^2.2.0",
140
+ "webpack": "^5.98.0"
141
+ },
142
+ "peerDependencies": {
143
+ "govuk-frontend": ">=5.8.0",
144
+ "react": ">=18.2.0",
145
+ "react-dom": ">=18.2.0",
146
+ "react-router-dom": ">=6.30.0"
147
+ },
148
+ "optionalDependencies": {
149
+ "pdfjs-dist": ">=4.10.38"
150
+ },
151
+ "jest": {
152
+ "testEnvironment": "jsdom",
153
+ "moduleNameMapper": {
154
+ ".(css|less|scss)$": "identity-obj-proxy"
155
+ },
156
+ "setupFilesAfterEnv": [
157
+ "<rootDir>/src/JestSetup.ts"
158
+ ],
159
+ "testEnvironmentOptions": {
160
+ "customExportConditions": [
161
+ "react-native"
162
+ ]
163
+ }
164
+ },
165
+ "babel": {
166
+ "presets": [
167
+ "@babel/preset-env",
168
+ "@babel/preset-react",
169
+ "@babel/preset-typescript"
170
+ ]
171
+ },
172
+ "eslintConfig": {
173
+ "extends": [
174
+ "plugin:storybook/recommended"
175
+ ]
176
+ },
177
+ "dependencies": {
178
+ "ts-dedent": "^2.2.0"
179
+ }
180
+ }