Merge pull request #5251 from alphagov/create-all-check

Add `isSupported` to `createAll`
alphagov · Aug 20, 2024 · 69763be · 69763be
2 parents f6c4859 + 3301745
commit 69763be
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/packages/govuk-frontend/src/govuk/init.jsdom.test.mjs b/packages/govuk-frontend/src/govuk/init.jsdom.test.mjs
@@ -146,8 +146,12 @@ describe('initAll', () => {
 })
 
 describe('createAll', () => {
+  beforeEach(() => {
+    document.body.classList.add('govuk-frontend-supported')
+  })
+
   afterEach(() => {
-    document.body.innerHTML = ''
+    document.body.outerHTML = '<body></body>'
   })
 
   class MockComponent {
@@ -176,6 +180,20 @@ describe('createAll', () => {
     expect(result).toStrictEqual([])
   })
 
+  it('throws error and returns empty array if not supported', () => {
+    document.body.classList.remove('govuk-frontend-supported')
+
+    const result = createAll(MockComponent)
+
+    expect(global.console.log).toHaveBeenCalledWith(
+      expect.objectContaining({
+        message: 'GOV.UK Frontend is not supported in this browser'
+      })
+    )
+
+    expect(result).toStrictEqual([])
+  })
+
   it('returns an empty array if no matching components exist on the page', () => {
     const componentRoot = document.createElement('div')
     componentRoot.setAttribute(

diff --git a/packages/govuk-frontend/src/govuk/init.mjs b/packages/govuk-frontend/src/govuk/init.mjs
@@ -74,6 +74,12 @@ function createAll(Component, config, $scope = document) {
     `[data-module="${Component.moduleName}"]`
   )
 
+  // Skip initialisation when GOV.UK Frontend is not supported
+  if (!isSupported()) {
+    console.log(new SupportError())
+    return []
+  }
+
   /* eslint-disable-next-line @typescript-eslint/no-unsafe-return --
    * We can't define CompatibleClass as `{new(): CompatibleClass, moduleName: string}`,
    * as when doing `typeof Accordion` (or any component), TypeScript doesn't seem