@charcoal-ui/react 4.0.1 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@charcoal-ui/react",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "license": "Apache-2.0",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",
@@ -33,7 +33,7 @@
     "test": "vitest run --passWithNoTests"
   },
   "devDependencies": {
-    "@charcoal-ui/esbuild-plugin-styled-components": "^4.0.1",
+    "@charcoal-ui/esbuild-plugin-styled-components": "^4.1.0",
     "@react-types/switch": "^3.1.2",
     "@storybook/addon-actions": "^8.0.5",
     "@storybook/react": "^8.0.5",
@@ -62,10 +62,10 @@
     "vitest": "^2.0.1"
   },
   "dependencies": {
-    "@charcoal-ui/foundation": "^4.0.1",
-    "@charcoal-ui/icons": "^4.0.1",
-    "@charcoal-ui/theme": "^4.0.1",
-    "@charcoal-ui/utils": "^4.0.1",
+    "@charcoal-ui/foundation": "^4.1.0",
+    "@charcoal-ui/icons": "^4.1.0",
+    "@charcoal-ui/theme": "^4.1.0",
+    "@charcoal-ui/utils": "^4.1.0",
     "@react-aria/button": "^3.9.1",
     "@react-aria/checkbox": "^3.13.0",
     "@react-aria/dialog": "^3.5.10",
@@ -98,5 +98,5 @@
     "url": "https://github.com/pixiv/charcoal.git",
     "directory": "packages/react"
   },
-  "gitHead": "42466af3a62cb99358f735a2ce16b237591a2579"
+  "gitHead": "e1d401460774c73120434d8be3bca5698d519493"
 }

package/src/components/Button/index.tsx

@@ -46,5 +46,11 @@ const Button = forwardRef(function Button<T extends React.ElementType>(
       ref={ref}
     />
   )
-}) as <T extends React.ElementType = 'button'>(p: ButtonProps<T>) => JSX.Element
+}) as <T extends React.ElementType = 'button'>(
+  p: 'button' extends T
+    ? ButtonProps<'button'>
+    : ButtonProps<T> & {
+        component: T // required
+      }
+) => JSX.Element
 export default Button

package/src/components/Button/styledButtonTypeTest.d.tsx

@@ -0,0 +1,81 @@
+// This file is for type testing only
+
+// only use the type
+import type { default as ButtonType } from './index'
+import type styledType from 'styled-components'
+
+declare const Button: typeof ButtonType
+declare const styled: typeof styledType
+
+const Custom = ({ custom }: { custom: string }) => <>{custom}</>
+const CustomGeneric = <C extends string>({ custom }: { custom: C }) => (
+  <>{custom}</>
+)
+
+const StyledButton = styled(Button)``
+const StyledButtonAsButton = styled(Button<'button'>)``
+const StyledButtonA = styled(Button<'a'>)``
+const StyledButtonCustom = styled(Button<typeof Custom>)``
+const StyledButtonCustomAsButton = styled(
+  Button<typeof Custom>
+)`` as typeof Button
+const StyledButtonCustomGeneric = styled(Button<typeof CustomGeneric>)``
+const StyledButtonCustomGenericFoo = styled(
+  Button<typeof CustomGeneric<'foo'>>
+)``
+
+// for type test only
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+function Tests() {
+  return (
+    <>
+      {/* OK */}
+
+      <StyledButton />
+      <StyledButton type="button" disabled />
+      <StyledButtonAsButton type="button" disabled />
+      <StyledButtonA component="a" href="#" />
+      <StyledButtonCustom component={Custom} custom="" />
+      <StyledButtonCustomAsButton<'a'> component="a" href="#" />
+      <StyledButtonCustomAsButton<typeof CustomGeneric<'bar'>>
+        component={CustomGeneric}
+        custom="bar"
+      />
+      <StyledButtonCustomAsButton component="a" href="#" />
+      <StyledButtonCustomGeneric component={CustomGeneric} custom="" />
+      <StyledButtonCustomGenericFoo component={CustomGeneric} custom="foo" />
+      <StyledButtonCustomGenericFoo
+        component={CustomGeneric<'foo'>}
+        custom="foo"
+      />
+
+      {/* NG */}
+
+      {/* @ts-expect-error Property 'href' does not exist on type  */}
+      <StyledButton href="" />
+      {/* @ts-expect-error Property 'href' does not exist on type  */}
+      <StyledButtonAsButton href="" />
+      {/* @ts-expect-error Property 'component' is missing */}
+      <StyledButtonA href="#" />
+      {/* @ts-expect-error Property 'disabled' does not exist on type  */}
+      <StyledButtonA disabled />
+      {/* @ts-expect-error Type '"button"' is not assignable to type '"a"'  */}
+      <StyledButtonA component="button" href="" />
+      {/* @ts-expect-error Property 'component' is missing */}
+      <StyledButtonCustom custom="" />
+      {/* @ts-expect-error Type 'string' is not assignable  */}
+      <StyledButtonCustom component="a" custom="" />
+      {/* @ts-expect-error Property 'custom' does not exist on type  */}
+      <StyledButtonCustomAsButton custom="" />
+      {/* @ts-expect-error Type 'href' is not assignable  */}
+      <StyledButtonCustomAsButton<'button'> href="#" />
+      <StyledButtonCustomGenericFoo
+        /* @ts-expect-error Type '"foo"' is not assignable to type '"bar"' */
+        component={CustomGeneric<'bar'>}
+        custom="foo"
+      />
+      {/* @ts-expect-error '""' is not assignable to type '"foo"' */}
+      <StyledButtonCustomGenericFoo custom="" />
+    </>
+  )
+}