Interface: SelectAreaProps
Hierarchy
↳
SelectAreaProps
Properties
ariaLabel
• Optional ariaLabel: string
Deprecated
- Use kebab-case aria-label instead Label to be used for accessibility purposes.
Inherited from
SharedComponentProps.ariaLabel
Defined in
packages/ida-framework/src/types.ts:46
children
• children: ReactNode | ReactNode[]
the SelectArea should be the parent of any other elements that require user interaction via the mouse.
Defined in
packages/ida-framework/src/features/selectArea/SelectArea.tsx:41
className
• Optional className: string
Inherited from
SharedComponentProps.className
Defined in
packages/ida-framework/src/types.ts:48
onSelectionChange
• Optional onSelectionChange: (selection: Selection) => void
Type declaration
▸ (selection): void
Event fired when the user's selection region changes.
Parameters
| Name | Type |
|---|---|
selection | Selection |
Returns
void
Defined in
packages/ida-framework/src/features/selectArea/SelectArea.tsx:45
onSelectionEnd
• Optional onSelectionEnd: (e: PointerEvent<Element>) => void
Type declaration
▸ (e): void
Pointer event fired when the user ends a selection (e.g. releases the mouse button)
Parameters
| Name | Type |
|---|---|
e | PointerEvent<Element> |
Returns
void
Defined in
packages/ida-framework/src/features/selectArea/SelectArea.tsx:53
onSelectionStart
• Optional onSelectionStart: (e: PointerEvent<Element>) => void
Type declaration
▸ (e): void
Pointer event fired when the user starts a selection (e.g. presses the mouse button)
Parameters
| Name | Type |
|---|---|
e | PointerEvent<Element> |
Returns
void
Defined in
packages/ida-framework/src/features/selectArea/SelectArea.tsx:49
role
• Optional role: AriaRole
Inherited from
Defined in
packages/ida-framework/src/types.ts:49
style
• Optional style: CSSProperties