Skip to content

Commit

Permalink
docs(jsdoc): add comment for BaseStyleProp
Browse files Browse the repository at this point in the history
Add JSDoc comments for BaseStyleProp interface

re #61

Signed-off-by: Niloy Sikdar <[email protected]>
  • Loading branch information
niloysikdar committed Aug 12, 2022
1 parent 02abee5 commit 449755b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/components/types/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import { CSSProperties } from 'react';

export interface BaseStyleProp<T extends string> {
/**
* The classes object to be merged with the base styles.
*/
classes?: Partial<Record<T, CSSProperties>>;
/**
* The class name to be applied to the element.
*/
className?: string;
}

0 comments on commit 449755b

Please sign in to comment.