@forge/react
11.17.0-experimental-04cc2b911.18.0-next.0
out/types/components.d.ts~
out/types/components.d.tsModified+41−41
Index: package/out/types/components.d.ts
===================================================================
--- package/out/types/components.d.ts
+++ package/out/types/components.d.ts
@@ -12,12 +12,12 @@
export interface BadgeProps {
appearance?: 'added' | 'default' | 'important' | 'primary' | 'removed';
text: string;
}
-export type NativeBadgeProps = Omit<BadgeProps, 'text'> & {
+export declare type NativeBadgeProps = Omit<BadgeProps, 'text'> & {
children: string;
};
-export type ButtonAppearance = 'default' | 'danger' | 'link' | 'primary' | 'subtle' | 'subtle-link' | 'warning';
+export declare type ButtonAppearance = 'default' | 'danger' | 'link' | 'primary' | 'subtle' | 'subtle-link' | 'warning';
export interface ButtonProps {
appearance?: ButtonAppearance;
text: string;
disabled?: boolean;
@@ -30,18 +30,18 @@
}
export interface ColumnsProps {
children: ForgeChildren;
}
-export type Align = 'start' | 'center' | 'end';
+export declare type Align = 'start' | 'center' | 'end';
export interface ColumnProps {
width?: number;
align?: Align;
children: ForgeChildren;
}
export interface ErrorPanelProps {
error: AuxPipelineUserVisibleError;
}
-export type FormData = Record<string, any>;
+export declare type FormData = Record<string, any>;
export interface FormProps<T extends FormData> {
children: ForgeChildren;
onSubmit: (data: T) => Promise<void> | void;
submitButtonText?: string;
@@ -59,9 +59,9 @@
}
export interface CustomFieldPrimitiveProps {
children: ForgeChildren;
}
-export type ModalDialogWidth = 'small' | 'medium' | 'large' | 'x-large';
+export declare type ModalDialogWidth = 'small' | 'medium' | 'large' | 'x-large';
export interface CustomFieldEditPrimitiveProps {
children: ForgeChildren;
fieldValue: {
value: CustomFieldValue;
@@ -79,9 +79,9 @@
export interface DashboardGadgetEditPrimitiveProps {
children: ForgeChildren;
formData: FormData;
}
-export type ImageSizes = 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
+export declare type ImageSizes = 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
export interface ImageProps {
src: string;
alt: string;
size?: ImageSizes;
@@ -126,11 +126,11 @@
header: string;
onClose: () => Promise<void> | void;
width?: ModalDialogWidth;
}
-export type ContainerProps = {};
-type LayoutTemplate = 'grid-2' | 'grid-3' | 'sidebar-left' | 'sidebar-right';
-export type LayoutProps = {
+export declare type ContainerProps = {};
+declare type LayoutTemplate = 'grid-2' | 'grid-3' | 'sidebar-left' | 'sidebar-right';
+export declare type LayoutProps = {
template: LayoutTemplate;
children: ForgeChildren;
};
export interface OptionProps {
@@ -178,15 +178,15 @@
}
export interface NativeCheckboxGroupProps extends CheckboxGroupProps {
onChange?: (values: Array<string>) => void;
}
-export type CodeLanguages = 'abap' | 'actionscript' | 'ada' | 'arduino' | 'autoit' | 'c' | 'c++' | 'coffeescript' | 'csharp' | 'css' | 'cuda' | 'd' | 'dart' | 'delphi' | 'elixir' | 'erlang' | 'fortran' | 'foxpro' | 'go' | 'graphql' | 'groovy' | 'haskell' | 'haxe' | 'html' | 'java' | 'javascript' | 'json' | 'julia' | 'kotlin' | 'latex' | 'livescript' | 'lua' | 'mathematica' | 'matlab' | 'objective-c' | 'objective-j' | 'objectpascal' | 'ocaml' | 'octave' | 'perl' | 'php' | 'powershell' | 'prolog' | 'puppet' | 'python' | 'qml' | 'r' | 'racket' | 'restructuredtext' | 'ruby' | 'rust' | 'sass' | 'scala' | 'scheme' | 'shell' | 'smalltalk' | 'sql' | 'standardml' | 'swift' | 'tcl' | 'tex' | 'text' | 'typescript' | 'vala' | 'vbnet' | 'verilog' | 'vhdl' | 'xml' | 'xquery';
+export declare type CodeLanguages = 'abap' | 'actionscript' | 'ada' | 'arduino' | 'autoit' | 'c' | 'c++' | 'coffeescript' | 'csharp' | 'css' | 'cuda' | 'd' | 'dart' | 'delphi' | 'elixir' | 'erlang' | 'fortran' | 'foxpro' | 'go' | 'graphql' | 'groovy' | 'haskell' | 'haxe' | 'html' | 'java' | 'javascript' | 'json' | 'julia' | 'kotlin' | 'latex' | 'livescript' | 'lua' | 'mathematica' | 'matlab' | 'objective-c' | 'objective-j' | 'objectpascal' | 'ocaml' | 'octave' | 'perl' | 'php' | 'powershell' | 'prolog' | 'puppet' | 'python' | 'qml' | 'r' | 'racket' | 'restructuredtext' | 'ruby' | 'rust' | 'sass' | 'scala' | 'scheme' | 'shell' | 'smalltalk' | 'sql' | 'standardml' | 'swift' | 'tcl' | 'tex' | 'text' | 'typescript' | 'vala' | 'vbnet' | 'verilog' | 'vhdl' | 'xml' | 'xquery';
export interface CodeProps {
text: string;
language?: CodeLanguages;
showLineNumbers?: boolean;
}
-export type NativeCodeProps = Omit<CodeProps, 'text'> & {
+export declare type NativeCodeProps = Omit<CodeProps, 'text'> & {
children: string;
};
export interface DateLozengeProps {
value: number;
@@ -201,20 +201,20 @@
}
export interface NativeDatePickerProps extends DatePickerProps {
onChange?: (value: string) => void;
}
-export type StatusLozengeAppearance = 'default' | 'inprogress' | 'moved' | 'new' | 'removed' | 'success';
+export declare type StatusLozengeAppearance = 'default' | 'inprogress' | 'moved' | 'new' | 'removed' | 'success';
export interface StatusLozengeProps {
appearance?: StatusLozengeAppearance;
text: string;
}
-export type NativeStatusLozengeProps = Omit<StatusLozengeProps, 'text'> & {
+export declare type NativeStatusLozengeProps = Omit<StatusLozengeProps, 'text'> & {
children: string;
};
export interface MentionProps {
accountId: string;
}
-export type TextFieldType = 'email' | 'number' | 'tel' | 'text' | 'password';
+export declare type TextFieldType = 'email' | 'number' | 'tel' | 'text' | 'password';
export interface TextFieldProps {
type?: TextFieldType;
name: string;
label: string;
@@ -223,22 +223,22 @@
description?: string;
placeholder?: string;
autoComplete?: 'off';
}
-export type NativeTextFieldProps = TextFieldProps & TextInputProps;
-export type HeadingProps = {
+export declare type NativeTextFieldProps = TextFieldProps & TextInputProps;
+export declare type HeadingProps = {
size?: 'small' | 'medium' | 'large';
children: ForgeChildren<string>;
};
-export type MarkupProps = {
+export declare type MarkupProps = {
children: ForgeChildren<ForgeNode | string | number>;
};
-export type LinkProps = {
+export declare type LinkProps = {
href: string;
openNewTab?: boolean;
appearance?: 'primary-button' | 'button' | 'link';
} & MarkupProps;
-export type StringProps = {
+export declare type StringProps = {
text: string;
};
export interface ThreeLOPromptProps {
message?: string;
@@ -275,14 +275,14 @@
title?: string;
appearance?: 'info' | 'warning' | 'error' | 'confirmation' | 'change';
children: ForgeChildren;
}
-export type TagColor = 'default' | 'green' | 'blue' | 'red' | 'purple' | 'grey' | 'teal' | 'yellow' | 'green-light' | 'blue-light' | 'red-light' | 'purple-light' | 'grey-light' | 'teal-light' | 'yellow-light';
+export declare type TagColor = 'default' | 'green' | 'blue' | 'red' | 'purple' | 'grey' | 'teal' | 'yellow' | 'green-light' | 'blue-light' | 'red-light' | 'purple-light' | 'grey-light' | 'teal-light' | 'yellow-light';
export interface TagProps {
color?: TagColor;
text: string;
}
-export type NativeTagProps = Omit<TagProps, 'text'> & {
+export declare type NativeTagProps = Omit<TagProps, 'text'> & {
children: string;
};
export interface TagGroupProps {
children: ForgeChildren;
@@ -307,9 +307,9 @@
value: CustomPortalFieldValue;
updated: boolean;
};
}
-export type CustomPortalFieldValue = {
+export declare type CustomPortalFieldValue = {
data: object | null;
isValid: boolean;
};
export interface PortalTextAreaProps {
@@ -319,9 +319,9 @@
spellCheck?: boolean;
onBlur: () => Promise<void> | void;
value?: string;
}
-export type NativeTextAreaProps = TextAreaProps & TextInputProps;
+export declare type NativeTextAreaProps = TextAreaProps & TextInputProps;
export interface ToggleProps {
name: string;
label: string;
defaultChecked?: boolean;
@@ -361,11 +361,11 @@
}
interface TextPropsWithChildren extends TextProps {
children: ForgeChildren<ForgeNode | string | number>;
}
-export type JsxTextProps = TextPropsWithContent | TextPropsWithChildren;
-export type TextAlign = 'start' | 'center' | 'end';
-export type RenderedTextProps = {
+export declare type JsxTextProps = TextPropsWithContent | TextPropsWithChildren;
+export declare type TextAlign = 'start' | 'center' | 'end';
+export declare type RenderedTextProps = {
content?: undefined;
align: TextAlign;
format: 'markup';
} | {
@@ -384,27 +384,27 @@
}
export interface CellProps {
children?: ForgeChildren;
}
-export type UserProps = {
+export declare type UserProps = {
accountId: string;
};
-export type UserGroupProps = {
+export declare type UserGroupProps = {
children: ForgeChildren;
};
export interface IssuePanelActionProps {
text: string;
onClick: () => Promise<void> | void;
}
-export type PressableAppearance = 'default' | 'primary' | 'subtle';
+export declare type PressableAppearance = 'default' | 'primary' | 'subtle';
export interface NativePressableProps {
onPress: () => void;
ariaLabel?: string;
disabled?: boolean;
appearance?: PressableAppearance;
children?: ForgeChildren<ForgeNode | string | number>;
}
-type NativeTableElementWidth = React.CSSProperties['width'];
+declare type NativeTableElementWidth = React.CSSProperties['width'];
interface CommonNativeTableProps {
id?: string;
children?: ForgeChildren<ForgeNode>;
}
@@ -412,25 +412,25 @@
colSpan?: number;
rowSpan?: number;
children?: ForgeChildren<ForgeNode | string | number>;
}
-export type NativeTableCaptionProps = {
+export declare type NativeTableCaptionProps = {
children: ForgeChildren<string>;
};
-export type NativeTableRootProps = CommonNativeTableProps & {
+export declare type NativeTableRootProps = CommonNativeTableProps & {
width?: NativeTableElementWidth;
};
-export type NativeTableHeadProps = CommonNativeTableProps;
-export type NativeTableBodyProps = CommonNativeTableProps;
-export type NativeTableFootProps = CommonNativeTableProps;
-export type NativeTableRowProps = CommonNativeTableProps;
-export type NativeTableHeadCellProps = CommonNativeTableCellProps & {
+export declare type NativeTableHeadProps = CommonNativeTableProps;
+export declare type NativeTableBodyProps = CommonNativeTableProps;
+export declare type NativeTableFootProps = CommonNativeTableProps;
+export declare type NativeTableRowProps = CommonNativeTableProps;
+export declare type NativeTableHeadCellProps = CommonNativeTableCellProps & {
scope?: 'col' | 'row' | 'colgroup' | 'rowgroup';
width?: NativeTableElementWidth;
};
-export type NativeTableCellProps = CommonNativeTableCellProps;
-export type Space = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
-export type NativeInlineProps = {
+export declare type NativeTableCellProps = CommonNativeTableCellProps;
+export declare type Space = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
+export declare type NativeInlineProps = {
children: ForgeChildren;
alignBlock?: 'start' | 'center' | 'end' | 'baseline' | 'stretch';
alignInline?: 'start' | 'center' | 'end';
grow?: 'hug' | 'fill';
@@ -438,9 +438,9 @@
space?: Space;
shouldWrap?: boolean;
rowSpace?: Space;
};
-export type NativeStackProps = {
+export declare type NativeStackProps = {
children: ForgeChildren;
alignBlock?: 'start' | 'center' | 'end';
alignInline?: 'start' | 'center' | 'end';
grow?: 'hug' | 'fill';