docs: update README

carbon-design-system · Oct 27, 2024 · 7d8c16f · 7d8c16f
1 parent c2e37cf
commit 7d8c16f
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ import type { SvelteHTMLElements } from "svelte/elements";
 
 type RestProps = SvelteHTMLElements["button"];
 
-export interface ButtonProps extends RestProps {
+type $Props = {
   /**
    * @default "button"
    */
@@ -53,7 +53,11 @@ export interface ButtonProps extends RestProps {
    * @default false
    */
   primary?: boolean;
-}
+
+  [key: `data-${string}`]: any;
+};
+
+export type ButtonProps = Omit<RestProps, keyof $Props> & $Props;
 
 export default class Button extends SvelteComponentTyped<
   ButtonProps,
@@ -83,7 +87,7 @@ import type { SvelteHTMLElements } from "svelte/elements";
 
 type RestProps = SvelteHTMLElements["button"];
 
-export interface ButtonProps extends RestProps {
+type $Props = {
   /**
    * @default "button"
    */
@@ -94,7 +98,9 @@ export interface ButtonProps extends RestProps {
    * @default false
    */
   primary?: boolean;
-}
+};
+
+export type ButtonProps = Omit<RestProps, keyof $Props> & $Props;
 
 export default class Button extends SvelteComponentTyped<
   ButtonProps,