Merge pull request #5134 from dimaMachina/tsdoc
fix `@default` TSDoc tags for `BackgroundProps`
This commit is contained in:
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'@xyflow/react': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
fix `@default` TSDoc tags for `BackgroundProps`
|
||||||
@@ -18,18 +18,18 @@ export enum BackgroundVariant {
|
|||||||
export type BackgroundProps = {
|
export type BackgroundProps = {
|
||||||
/** When multiple backgrounds are present on the page, each one should have a unique id. */
|
/** When multiple backgrounds are present on the page, each one should have a unique id. */
|
||||||
id?: string;
|
id?: string;
|
||||||
/** Color of the pattern */
|
/** Color of the pattern. */
|
||||||
color?: string;
|
color?: string;
|
||||||
/** Color of the background */
|
/** Color of the background. */
|
||||||
bgColor?: string;
|
bgColor?: string;
|
||||||
/** Class applied to the container */
|
/** Class applied to the container. */
|
||||||
className?: string;
|
className?: string;
|
||||||
/** Class applied to the pattern */
|
/** Class applied to the pattern. */
|
||||||
patternClassName?: string;
|
patternClassName?: string;
|
||||||
/**
|
/**
|
||||||
* The gap between patterns. Passing in a tuple allows you to control the x and y gap
|
* The gap between patterns. Passing in a tuple allows you to control the x and y gap
|
||||||
* independently.
|
* independently.
|
||||||
* @default '28'
|
* @default 20
|
||||||
*/
|
*/
|
||||||
gap?: number | [number, number];
|
gap?: number | [number, number];
|
||||||
/**
|
/**
|
||||||
@@ -39,8 +39,8 @@ export type BackgroundProps = {
|
|||||||
*/
|
*/
|
||||||
size?: number;
|
size?: number;
|
||||||
/**
|
/**
|
||||||
* Offset of the pattern
|
* Offset of the pattern.
|
||||||
* @default 2
|
* @default 0
|
||||||
*/
|
*/
|
||||||
offset?: number | [number, number];
|
offset?: number | [number, number];
|
||||||
/**
|
/**
|
||||||
@@ -49,12 +49,12 @@ export type BackgroundProps = {
|
|||||||
*/
|
*/
|
||||||
lineWidth?: number;
|
lineWidth?: number;
|
||||||
/**
|
/**
|
||||||
* Variant of the pattern
|
* Variant of the pattern.
|
||||||
* @default BackgroundVariant.Dots
|
* @default BackgroundVariant.Dots
|
||||||
* @example BackgroundVariant.Lines, BackgroundVariant.Dots, BackgroundVariant.Cross
|
* @example BackgroundVariant.Lines, BackgroundVariant.Dots, BackgroundVariant.Cross
|
||||||
* 'lines', 'dots', 'cross'
|
* 'lines', 'dots', 'cross'
|
||||||
*/
|
*/
|
||||||
variant?: BackgroundVariant;
|
variant?: BackgroundVariant;
|
||||||
/** Style applied to the container */
|
/** Style applied to the container. */
|
||||||
style?: CSSProperties;
|
style?: CSSProperties;
|
||||||
};
|
};
|
||||||
|
|||||||
Reference in New Issue
Block a user