mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-08-26 20:22:18 +00:00
1.4 KiB
1.4 KiB
JavaScript Components
This document details the format for JavaScript components in BookStack. This is a really simple class-based setup with a few helpers provided.
Defining a Component in JS
class Dropdown {
setup() {
this.toggle = this.$refs.toggle;
this.menu = this.$refs.menu;
this.speed = parseInt(this.$opts.speed);
}
}
All usage of $refs, $manyRefs and $opts should be done at the top of the setup
function so any requirements can be easily seen.
Using a Component in HTML
A component is used like so:
<div component="dropdown"></div>
<!-- or, for multiple -->
<div components="dropdown image-picker"></div>
The names will be parsed and new component instance will be created if a matching name is found in the components/index.js
componentMapping.
Element References
Within a component you'll often need to refer to other element instances. This can be done like so:
<div component="dropdown">
<span refs="dropdown@toggle othercomponent@handle">View more</span>
</div>
You can then access the span element as this.$refs.toggle
in your component.
Component Options
<div component="dropdown"
option:dropdown:delay="500"
option:dropdown:show>
</div>
Will result with this.$opts
being:
{
"delay": "500",
"show": ""
}