ButtonLinkEdit Class
The ButtonLinkEdit class provides functionality for creating and editing a link in a document. Provides UI for creating, editing and removing a link.
Index
Methods
- _clearLink
- _focusLinkInput
- _getFocusAction
- _getFocusDismissAction
- _getFocusMoveDirection
- _handleKeyDown
- _handleLinkAutocompleteClick
- _handleLinkHrefChange
- _handleLinkTargetChange
- _isValidKey
- _isValidState
- _moveFocus
- _refresh
- _removeLink
- _setAutocompleteState
- _updateLink
- componentDidMount
- componentDidUpdate
- componentWillReceiveProps
- focus
- getDefaultProps
- getInitialState
- handleKey
- mergeButtonCfgProps
- mergeDropdownProps
- moveFocus
- render
- toggleDropdown
Methods
_clearLink
()
protected
Clears the link input. This only changes the component internal state, but does not affect the link element of the editor. Only the _removeLink and _updateLink methods are translated to the editor element.
_focusLinkInput
()
protected
Focuses the user cursor on the widget's input.
_getFocusAction
-
event
Returns the action, if any, that a keyboard event in the current focus manager state should produce.
Parameters:
-
eventObjectThe Keyboard event.
Returns:
An action object with type and direction properties.
_getFocusDismissAction
-
event -
focusMoveDirection
Returns the dismiss action, if any, the focus manager should execute to yield the focus. This will happen in any of these scenarios if a dismiss callback has been specified:
- A dismiss key has been pressed
- In a non-circular focus manager, when:
- The active descendant is the first one and a prev key has been pressed.
- The active descendant is the last one and a next key has been pressed.
Parameters:
-
eventObjectThe Keyboard event.
-
focusMoveDirectionNumberThe focus movement direction (if any).
Returns:
A dismiss action with dismiss and direction properties.
_getFocusMoveDirection
-
event
Returns the direction, if any, in which the focus should be moved. In presence of the shift key modifier, the direction of the movement is inverted.
Parameters:
-
eventObjectThe Keyboard event.
Returns:
The computed direction of the expected focus movement.
_handleKeyDown
-
event
Monitors key interaction inside the input element to respond to the keys:
- Enter: Creates/updates the link.
- Escape: Discards the changes.
Parameters:
-
eventSyntheticEventThe keyboard event.
_handleLinkAutocompleteClick
-
event
Updates the component state when an autocomplete link result is selected by user interaction.
Parameters:
-
eventSyntheticEventThe click event.
_handleLinkHrefChange
-
event
Updates the component state when the link input changes on user interaction.
Parameters:
-
eventSyntheticEventThe change event.
_handleLinkTargetChange
-
event
Updates the component state when the link target changes on user interaction.
Parameters:
-
eventSyntheticEventThe click event.
_isValidKey
-
keyCode -
keys
Indicates if a given keyCode is valid for the given set of keys.
Parameters:
-
keyCodeNumberAn event keyCode.
-
keysArray | NumberA key set. Can be a number an array of numbers representing the allowed keyCodes.
Returns:
A boolean value indicating if the key is valid.
_isValidState
()
Boolean
protected
Verifies that the current link state is valid so the user can save the link. A valid state means that we have a non-empty href and that either that or the link target are different from the original link.
Returns:
[description]
_moveFocus
-
direction
Moves the focus among descendants in the especified direction.
Parameters:
-
directionNumberThe direction (1 or -1) of the focus movement among descendants.
_refresh
()
protected
Refreshes the descendants list by executing the CSS selector again and resets the descendants tabIndex.
_removeLink
()
protected
Removes the link in the editor element.
_setAutocompleteState
()
protected
Update autocompleteSelected state to focus and select autocomplete´s dropdown
_updateLink
()
protected
Updates the link in the editor element. If the element didn't exist previously, it will create a new element with the href specified in the link input.
componentDidMount
()
Lifecycle. Invoked once, only on the client, immediately after the initial rendering occurs.
Focuses on the link input to immediately allow editing. This should only happen if the component is rendered in exclusive mode to prevent aggressive focus stealing.
componentDidUpdate
()
Lifecycle. Invoked immediately after the component's updates are flushed to the DOM. Refreshes the descendants list.
componentWillReceiveProps
()
Lifecycle. Invoked when a component is receiving new props. This method is not called for the initial render.
focus
()
Focuses the current active descendant.
Several Widgets can be nested in a component hierarchy by attaching this focus method to the widget DOM node, transferring the DOM focus control to the inner FocusManager.
getDefaultProps
()
Object
Lifecycle. Returns the default values of the properties used in the widget.
Returns:
The default properties.
getInitialState
()
Lifecycle. Invoked once before the component is mounted. The return value will be used as the initial value of this.state.
handleKey
-
event
Handles the key events on a DOM node to execute the appropriate navigation when needed.
Parameters:
-
eventObjectThe Keyboard event that was detected on the widget DOM node.
mergeButtonCfgProps
-
props
Merges the properties, passed to the current component with user's configuration
via buttonCfg property.
Parameters:
-
propsObjectThe properties to be merged with the provided configuration for this button. If not passed, the user configuration will be merged with
this.props
Returns:
The merged properties
mergeDropdownProps
-
obj -
itemKey
Merges the provided object with two more properties:
- expanded - boolean flag which indicates if an widget should be rendered exclusively.
- toggleDropdown - function, which can be used by an widget in order to obtain exclusive state.
Parameters:
-
objObjectThe properties container which should be merged with the properties, related to dropdown state.
-
itemKeyObjectThey key of an React Widget which contains the dropdown.
Returns:
The merged object.
moveFocus
-
direction
Moves the focus among descendants in the especified direction.
Parameters:
-
directionNumberThe direction (1 or -1) of the focus movement among descendants.
render
()
Object
Lifecycle. Renders the UI of the button.
Returns:
The content which should be rendered.
toggleDropdown
-
itemDropdown -
toggleDirection
Sets the active dropdown of the widget or discards the toggled item from the state.
Parameters:
-
itemDropdownObjectThe widget which requests to toggle its dropdown.
-
toggleDirectionNumberUser movement direction when toggled via keyboard.
Properties
allowedTargets
Array
List of the allowed values for the target attribute.
appendProtocol
Boolean
Indicate if we add http:// protocol to link or not
circular
Boolean
Indicates if focus should be set to the first/last descendant when the limits are reached.
data
Function | Array
List of items to be rendered as possible values for the link or a function, which is supposed to retrieve the data. The function should return a Promise. The returned items must be objects with at least two properties:
- title
- url
defaultLinkTarget
String
Default value of the link target attribute.
descendants
String
String representing the CSS selector used to define the elements that should be handled.
editor
Object
The editor instance where the component is being used.
focusFirstChild
Boolean
Indicate if should focus the first child of a container
key
String
static
The name which will be used as an alias of the button in the configuration.
Default: linkEdit
keys
Object
Object representing the keys used to navigate between descendants. The format for the prop is:
{dismiss: value, dismissNext: value, dismissPrev: value, next: value, prev: value} where
value can be both a number or an array of numbers with the allowed keyCodes.
onDismiss
Function
Callback method to be invoked when the focus manager is to be dismissed. This happens in the following scenarios if a dismiss callback has been specified:
- A dismiss key has been pressed
- In a non-circular focus manager, when:
- The active descendant is the first one and a prev key has been pressed.
- The active descendant is the last one and a next key has been pressed.
showTargetSelector
Boolean
Indicates whether the link target selector should appear.