Components

Box

<Box title />

Constructor

# <Box title />

This component is just a Box with border. It serves as an example of how you can incorporate components together.

Component also has slots, methods and events.

PropTypes:
Name Type Required Description Default
title string No This will be in the header "My box"

View Source components/Box.vue, line 31

Examples

Basic usage just with the default slot

Using second component inside

Example of passing an entire component in a preview

Slots

# options

Here should go all the top header options

# default

Main, central, content of the component

Methods

# static exampleMethod(prop1, prop2)

Also, you can describe methods for each component the same as you would do this in regular @jsdoc documented file

Parameters:
Name Type Description
prop1 string

some example property

prop2 string

other property

View Source components/Box.vue, line 51

Events

# unexpectedEvent

This event could be thrown by component in case of some kind of unexpected behaviour.

View Source components/Box.vue, line 55