The component to resize in height or width. Can be a component ID, itemId property, Component instance or custom function
Protected
Optional
_clsPrivate
Optional
_resizeProtected
baseA base class not configurable. cls can be used to add extra classes leaving this class alone
Readonly
dataSet arbitrary data on a component.
Should be used with caution as this data is not typed.
Protected
Optional
dragOptional
invertWhen the panel is on the left of a center panel that auto sizes. The x offset can be added to the width. But if the panel is on the right the x offset must be inverted. If not given the splitter will auto detect it's position relative to the component it resizes
Optional
maxThe maximim size it will set. Note that you can also put a max-width or max-height on the element with css.
The minimum size it will set. Note that you can also put a min-width or min-height on the element with css.
Optional
parentWhen this item is added to a Component this is set to the parent Component
Optional
renderNormally components are rendered to its parent component's element. But in some cases like menu's it's desired to render them to the root and position them absolute.
Private
resizeThe component to resize in height or width. Can be a component ID, itemId property, Component instance or custom function
Optional
resizeResize the widths when this hr is styled as a vertical splitter, otherwise the height is set.
Optional
setUpdate left and top css properties when dragging
Optional
stateID used for storing state of the component in the State storage.
If stateId is given it will also be used as itemId
If not set then the component won't store it's state.
Readonly
tagThe tagname used for the root HTMLElement of this component
Set attributes of the DOM element
Class name to add to element
Some common classes to add for layout:
Other:
Disable component
Enable or disable dragging
CSS flex value
CSS flex value
The height in scalable pixels
width
Hide element
Set the HTML contents of the component (innerHTML)
Element ID
Protected
itemComponent item ID that can be used to lookup the Component inside a Component with Component.findItem() and Component.findItemIndex();
if stateId is given it will also be used as itemId
The child components of this component
Check if the component has been rendered and added to the DOM tree
Make it resizable
Set inline style
The tabindex attribute specifies the tab order of an element (when the "tab" button is used for navigating).
Set the innerText
Title of the dom element
Set the width in scalable pixels
The width is applied in rem units divided by 10. Because the font-size of the html element has a font-size of 62.5% this is equals the amount of pixels, but it can be scaled easily for different themes.
Private
applyProtected
buildFind ancestor
The method traverses the Component's ancestors (heading toward the document root) until it finds one where the given function returns true.
When the function returns true the item will be returned. Otherwise it will move up to the next parent.
Find parent by instance type of the parent
const form = textField.findAncestorByType(Form);
Find a child at any level by element ID, itemId property, Component instance or custom function.
It cascades down the component hierarchy. See also {@see findChildByType}
Find child by instance type of the parent
const form = textField.findAncestorByType(Form);
Find children at any level by element ID, itemId property, Component instance or custom function.
It cascades down the component hierarchy. See also {@see findChildByType}
Find children by instance type of the parent
const form = textField.findAncestorByType(Form);
Find the item by element ID, itemId property, Component instance or custom function.
If you want to search the component tree hierarchy use {@see findChild()}
Find the item by element ID, itemId property, Component instance or custom function
Private
findFire an event
When a listener returns false this function will return false too.
Rest
...args: Parameters<DraggableComponentEventMap<any>[K]>Protected
getProtected
getProtected
getProtected
hasHide this component
This sets the "hidden" attribute on the DOM element which set's CSS display:none. You can change this to fade with css class "goui-fade-in" and "goui-fade-out"
If you want to override this function, please override internalSetHidden instead so the beforeshow and show event fire at the right time.
Protected
internalProtected
internalProtected
internalAdd a listener
Optional
options: ObservableListenerOptsProtected
onProtected
relayProtected
renderProtected
Can be overriden to wrap the component
Protected
renderProtected
restoreProtected
Restore state of the component in this function. It's called before render in init().
saveState();
Protected
saveRemove listener
Static
uniqueIDGenerated using TypeDoc
Splitter
Used to resize panels