added typedocs for plugins

This commit is contained in:
peterkogo
2024-01-15 17:38:54 +01:00
parent e35e0348fe
commit 8c32b426f4
10 changed files with 151 additions and 0 deletions
@@ -8,14 +8,27 @@ export enum BackgroundVariant {
export type BackgroundProps = {
id?: string;
/** color of the pattern */
color?: string;
/** color of the background */
bgColor?: string;
/** class applied to the container */
className?: string;
/** class applied to the pattern */
patternClassName?: string;
/** gap between repetitions of the pattern */
gap?: number | [number, number];
/** size of a single pattern element */
size?: number;
/** offset of the pattern */
offset?: number;
/** line width of the Line pattern */
lineWidth?: number;
/** variant of the pattern
* @example BackgroundVariant.Lines, BackgroundVariant.Dots, BackgroundVariant.Cross
* 'lines', 'dots', 'cross'
*/
variant?: BackgroundVariant;
/** style applied to the container */
style?: CSSProperties;
};