ak-button
Advanced tools
Readme
Buttons are used as triggers for actions. They are used in forms, toolbars, dialog footers and as stand-alone action triggers.
Interact with a live demo of the ak-button component.
npm install ak-button
This package exports the ak-button skate component.
Import the component in your JS resource:
import AkButton from 'ak-button';
Now you can use the defined tag in your HTML markup:
<html>
<head>
<script src="bundle.js"></script>
</head>
<body>
<!-- ... -->
<ak-button>testing</ak-button>
</body>
It can be used as a Constructor:
import AkButton from 'ak-button';
const myButton = new AkButton();
myButton.innerHTML = 'testing' // renders <ak-button>testing</ak-button>
document.body.appendChild(myButton) // Needed to be attached to the DOM to be rendered
Or nested inside skate elements. For example:
import 'ak-button';
const { vdom, define } = skate;
const { element } = vdom;
const MyButton = define('my-elem', {
render() {
element('ak-button', () => {
vdom.text('My Button');
});
}
});
document.body.appendChild(new MyButton()) // renders <ak-button>My Button</ak-button>
This is a standard web component, if you want to use it in your React app, use the Skate.js React integration.
import AkButton from 'ak-button';
import reactify from 'skatejs-react-integration';
const ReactComponent = reactify(AkButton, {});
ReactDOM.render(<ReactComponent />, container);
Kind: global class
Properties
stringstringstringstringbooleanstringbooleanCreates instances of ak-button programmatically, or using markup.
JS Example
import Button from 'ak-button';
const button = new Button();
stringPredefined appearances of an ak-button. One of: 'primary', 'standard', 'subtle', 'compact'
Kind: static property of Button
Default: "'standard'"
HTML Example
<ak-button appearance="primary"></ak-button>
JS Example
button.appearance = 'primary';
stringType of the ak-button. One of: 'button', 'submit'.
Kind: static property of Button
Default: "button"
HTML Example
<ak-button type="submit"></ak-button>
JS Example
button.type = 'submit';
stringhref of the ak-button. If href is set, button will redirect to href url when clicked.
Kind: static property of Button
Default: "button"
HTML Example
<ak-button href="www.atlassian.com"></ak-button>
JS Example
button.href = 'www.atlassian.com';
stringStandard target attribute for hyperlinks
Kind: static property of Button
HTML Example
<ak-button target="_blank"></ak-button>
JS Example
button.target = '_blank';
booleanOption to disable button and every click event
Kind: static property of Button
Default: false
HTML Example
<ak-button disabled></ak-button>
JS Example
button.disabled = true;
stringOption to change button's padding. One of: 'none', 'compact'
Kind: static property of Button
Default: "'normal'"
HTML Example
<ak-button spacing="compact"></ak-button>
JS Example
button.spacing = 'none';
booleanOption to make a button selected
Kind: static property of Button
Default: false
HTML Example
<ak-button selected></ak-button>
JS Example
button.selected = true;
Let us know what you think of our components and docs, your feedback is really important for us.
Ask a question in our forum.
Check if someone has already asked the same question before.
Are you in trouble? Let us know!
FAQs
A React component that is used to trigger events.
The npm package ak-button receives a total of 344 weekly downloads. As such, ak-button popularity was classified as not popular.
We found that ak-button demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.