@oslokommune/punkt-react 16.20.0 → 16.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oslokommune/punkt-react",
-  "version": "16.20.0",
+  "version": "16.21.0",
   "description": "React komponentbibliotek til Punkt, et designsystem laget av Oslo Origo",
   "homepage": "https://punkt.oslo.kommune.no",
   "author": "Team Designsystem, Oslo Origo",
@@ -39,7 +39,7 @@
   "dependencies": {
     "@lit-labs/ssr-dom-shim": "^1.2.1",
     "@lit/react": "^1.0.7",
-    "@oslokommune/punkt-elements": "^16.19.0",
+    "@oslokommune/punkt-elements": "^16.21.0",
     "classnames": "^2.5.1",
     "prettier": "^3.3.3",
     "react-hook-form": "^7.53.0"
@@ -109,5 +109,5 @@
     "url": "https://github.com/oslokommune/punkt/issues"
   },
   "license": "MIT",
-  "gitHead": "dee5033c347f7c10530f57d5dc05c5411b75033f"
+  "gitHead": "f7f1779ccee5d510e6d011e7ec3edba89b41c255"
 }

package/src/components/loader/Loader.test.tsx

@@ -1,38 +1,75 @@
 import '@testing-library/jest-dom'
 
-import { render } from '@testing-library/react'
+import { act, render } from '@testing-library/react'
 import { axe, toHaveNoViolations } from 'jest-axe'
+import { vi } from 'vitest'
 
 import { PktLoader } from './Loader'
 expect.extend(toHaveNoViolations)
 
 describe('PktLoader', () => {
   describe('basic rendering', () => {
-    it('renders correctly without any props', async () => {
+    it('renders correctly without any props', () => {
       const { container } = render(<PktLoader id="loader1" />)
-      await window.customElements.whenDefined('pkt-loader')
 
-      const element = container.querySelector('pkt-loader')
-      expect(element).toBeInTheDocument()
+      const root = container.querySelector('.pkt-loader')
+      expect(root).toBeInTheDocument()
+      expect(root).toHaveAttribute('id', 'loader1')
+      expect(root).toHaveAttribute('role', 'status')
+      expect(root).toHaveAttribute('aria-busy', 'true')
     })
 
-    it('renders with size and variant', async () => {
-      const { container } = render(<PktLoader id="loader1" size="small" variant="rainbow" message="Loading.." />)
-      await window.customElements.whenDefined('pkt-loader')
+    it('renders with size and variant', () => {
+      const { container } = render(
+        <PktLoader id="loader1" size="small" variant="rainbow" message="Loading.." />,
+      )
 
-      const loaderBox = container.querySelector('pkt-loader')
-      const loaderSize = loaderBox?.querySelector('.pkt-loader--small')
-
-      expect(loaderSize).toBeInTheDocument()
-      expect(loaderBox).toHaveTextContent('Loading..')
+      const root = container.querySelector('.pkt-loader')
+      expect(root).toHaveClass('pkt-loader--small')
+      expect(root?.querySelector('.pkt-loader__spinner')).toBeInTheDocument()
+      expect(root).toHaveTextContent('Loading..')
     })
 
-    it('renders inline', async () => {
+    it('renders inline', () => {
       const { container } = render(<PktLoader size="medium" message="Loading.." inline />)
-      await window.customElements.whenDefined('pkt-loader')
-      const elementInline = container.querySelector('.pkt-loader--inline')
+      expect(container.querySelector('.pkt-loader--inline')).toBeInTheDocument()
+    })
+
+    it('hides children while loading and shows them when not loading', () => {
+      const { container, rerender } = render(
+        <PktLoader isLoading>
+          <span data-testid="child">Innhold</span>
+        </PktLoader>,
+      )
+
+      const slot = container.querySelector('.pkt-contents')
+      expect(slot).toHaveClass('pkt-hide')
+      expect(slot?.querySelector('[data-testid="child"]')).toBeInTheDocument()
+
+      rerender(
+        <PktLoader isLoading={false}>
+          <span data-testid="child">Innhold</span>
+        </PktLoader>,
+      )
+      expect(container.querySelector('.pkt-contents')).not.toHaveClass('pkt-hide')
+      expect(container.querySelector('.pkt-loader__spinner')).not.toBeInTheDocument()
+    })
+  })
+
+  describe('delay', () => {
+    it('defers the spinner until after the delay has elapsed', () => {
+      vi.useFakeTimers()
+      try {
+        const { container } = render(<PktLoader delay={500} />)
+        expect(container.querySelector('.pkt-loader__spinner')).not.toBeInTheDocument()
 
-      expect(elementInline).toBeInTheDocument()
+        act(() => {
+          vi.advanceTimersByTime(500)
+        })
+        expect(container.querySelector('.pkt-loader__spinner')).toBeInTheDocument()
+      } finally {
+        vi.useRealTimers()
+      }
     })
   })
 

package/src/components/loader/Loader.tsx

@@ -1,33 +1,123 @@
 'use client'
 
-import { createComponent } from '@lit/react'
-import { type IPktLoader as IPktElLoader, PktLoader as PktElLoader } from '@oslokommune/punkt-elements'
-// eslint-disable-next-line no-restricted-syntax -- React is required for createComponent
-import React, { FC, ForwardedRef, forwardRef, type ReactElement } from 'react'
+import classNames from 'classnames'
+import { forwardRef, HTMLAttributes, ReactNode, useEffect, useState } from 'react'
 
-import type { PktElConstructor, PktElType } from '@/interfaces/IPktElements'
+import { PktIcon } from '../icon/Icon'
 
-type ExtendedLoader = IPktElLoader & PktElType
+declare global {
+  interface Window {
+    pktAnimationPath?: string
+  }
+}
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
-export interface IPktLoader extends ExtendedLoader {}
+if (typeof window !== 'undefined') {
+  window.pktAnimationPath =
+    window.pktAnimationPath || 'https://punkt-cdn.oslo.kommune.no/latest/animations/'
+}
 
-const LitComponent: FC<IPktLoader> = createComponent({
-  tagName: 'pkt-loader',
-  elementClass: PktElLoader as PktElConstructor<HTMLElement>,
-  react: React,
-  displayName: 'PktLoader',
-  events: {},
-})
+export type TPktLoaderVariant = 'blue' | 'rainbow' | 'shapes'
+export type TPktLoaderSize = 'small' | 'medium' | 'large'
+
+export interface IPktLoader extends HTMLAttributes<HTMLDivElement> {
+  /**
+   * Tid i millisekunder før loader vises. Nyttig når lastetiden kan være
+   * så kort at loader ikke trengs.
+   */
+  delay?: number
+  /**
+   * Vises loader inline eller som blokk.
+   */
+  inline?: boolean
+  /**
+   * Styrer om loader eller barnenoder vises. Når `false` vises barnenoder.
+   */
+  isLoading?: boolean
+  /**
+   * Meldingstekst som vises sammen med loader.
+   */
+  message?: string | null
+  /**
+   * Størrelse på loader. Standard er "medium".
+   */
+  size?: TPktLoaderSize
+  /**
+   * Loader-variant. Standard er "shapes" (Oslo-bølger). Andre er "blue" og "rainbow" (spinner-varianter).
+   */
+  variant?: TPktLoaderVariant
+  /**
+   * Overstyrer stien til loader-animasjoner.
+   */
+  loadingAnimationPath?: string
+  children?: ReactNode
+}
 
-export const PktLoader: FC<IPktLoader> = forwardRef(
-  ({ children, ...props }: IPktLoader, ref: ForwardedRef<HTMLElement>): ReactElement => {
-    return (
-      <LitComponent {...props} ref={ref}>
-        <div className="pkt-contents">{children}</div>
-      </LitComponent>
-    )
+const variantIcon = (variant: TPktLoaderVariant): string => {
+  switch (variant) {
+    case 'blue':
+      return 'spinner-blue'
+    case 'rainbow':
+      return 'spinner'
+    default:
+      return 'loader'
+  }
+}
+
+export const PktLoader = forwardRef<HTMLDivElement, IPktLoader>(function PktLoader(
+  {
+    delay = 0,
+    inline = false,
+    isLoading = true,
+    message = null,
+    size = 'medium',
+    variant = 'shapes',
+    loadingAnimationPath = typeof window !== 'undefined' ? window.pktAnimationPath : undefined,
+    className,
+    children,
+    ...rest
   },
-)
+  ref,
+) {
+  const [shouldDisplayLoader, setShouldDisplayLoader] = useState(delay === 0)
+
+  useEffect(() => {
+    if (delay > 0) {
+      setShouldDisplayLoader(false)
+      const handle = setTimeout(() => setShouldDisplayLoader(true), delay)
+      return () => clearTimeout(handle)
+    }
+    setShouldDisplayLoader(true)
+  }, [delay])
+
+  const classes = classNames(
+    'pkt-loader',
+    inline ? 'pkt-loader--inline' : 'pkt-loader--box',
+    `pkt-loader--${size}`,
+    className,
+  )
+
+  return (
+    <div
+      {...rest}
+      ref={ref}
+      role="status"
+      aria-live="polite"
+      aria-busy={isLoading ? 'true' : 'false'}
+      className={classes}
+    >
+      {isLoading && shouldDisplayLoader && (
+        <div className="pkt-loader__spinner">
+          <PktIcon
+            name={variantIcon(variant)}
+            path={loadingAnimationPath}
+            className={`pkt-loader__svg pkt-loader__${variant}`}
+          />
+          {message && <p>{message}</p>}
+        </div>
+      )}
+      <div className={classNames('pkt-contents', isLoading && 'pkt-hide')}>{children}</div>
+    </div>
+  )
+})
 
 PktLoader.displayName = 'PktLoader'