Documentation

Report Edit

Links

import {Link} from 'cx/widgets';

Links are used for pushState navigation between pages.

Links
<div class="widgets">
   <Link href="~/widgets/link-buttons">Link Buttons</Link>
</div>
Copied!Cx Fiddle
PropertyDescriptionType
activeClass

Additional CSS class to be applied to the element when it's active.

string/object
activeStyle

Additional CSS style to be applied to the element when it's active.

string/object
confirm

Confirmation text or configuration object. See MsgBox.yesNo for more details.

string/object
enabled

Set to false to disable the button. Do not use both enabled and disabled on the same widget.

boolean
href

Url to the link's target location. The link should start with ~/ or #/ for pushState/hash based navigation. The +/ prefix can be used to build a URL relative to the parent route.

string
inactiveClass

Additional CSS class to be applied to the element when it's not active.

string/object
inactiveStyle

Additional CSS style to be applied to the element when it's not active.

string/object
match

Accepted values are equal, prefix and subroute. Default is equal which means that url must exactly match href in order to consider the link active. In prefix mode, if href is a prefix of url, the link is considered active. The subroute mode is similar to prefix mode, except that the href must be followed by a forward slash /, indicating a subroute.

string
pressed

If true button appears in pressed state. Useful for implementing toggle buttons.

boolean
target

This attribute specifies where to open the linked document.

string
url

Binding to the current url location in the store. If href matches url, additional CSS class active is applied.

string
autoFocus

Set to true to automatically focus the element when mounted.

boolean
baseClass

Base CSS class to be applied to the element. Default is 'link'.

string
class
className

Additional CSS classes to be applied to the element. If an object is provided, all keys with a "truthy" value will be added to the CSS class list.

string/object
disabled

Set to true to disable the link.

boolean
dismiss

If set to true, the Button will cause its parent Overlay (if one exists) to close. This, however, can be prevented if onClick explicitly returns false.

boolean
focusOnMouseDown

Determines if button should receive focus on mousedown event. Default is false, which means that focus can be set only using the keyboard Tab key.

boolean
icon

Name of the icon to be put on the left side of the button.

string
innerHtml
html

HTML to be injected into the element.

string
items
children

List of child elements.

array
layout

Define an inner layout.

string/object
mod

Appearance modifier. Cx ships with primary and danger mods.

string/array
outerLayout

Defines the outer layout which wraps the widget.

widget
plainText

Set to true to avoid converting inner strings to templates. Default is false.

boolean
preserveWhitespace
ws

Keep whitespace in text based children. Default is false. See also trimWhitespace.

boolean
putInto
contentFor

Used with outer layouts. Specifies the name of the content placeholder which should render the widget.

string
style

Style object applied to the wrapper div. Used for setting the dimensions of the element.

string/object
submit

Add type="submit" to the button.

boolean
tag

HTML tag to be used. Default is button.

string
text
innerText

Inner text contents.

string
tooltip

Tooltip configuration. For more info see Tooltips.

string/object
trimWhitespace

Remove all whitespace in text based children. Default is true. See also preserveWhitespace.

boolean
vdomKey

Key that will be used as the key when rendering the React component.

string
visible
if

Visibility of the widget. Defaults to true.

boolean