View Source Surface.Catalogue.Example (surface v0.11.5)

A generic LiveView to create a single example for catalogue tools.

Options

Besides the buit-in options provided by the LiveView itself, an Example also provides the following options:

• subject - Required. The target component of the Example.

• height - Required. The height of the Example.

• catalogue - Optional. A module that implements the Surface.Catalogue providing additional information to the catalogue tool. Usually required if you want to share your components as a library.

• body - Optional. Sets/overrides the attributes of the the Example's body tag. Useful to set a different background or padding.

• title - Optional. The title of the example.

• direction - Optional. Defines how the example + code boxes should be displayed. Available values are "horizontal" or "vertical". Default is "horizontal" (side-by-side).

• code_perc - Optional. When the direction is "horizontal", defines the percentage of the total width that the code box should take. Default is 50. Note: This configuration has no effect when direction is "vertical".

• assert - Optional. When using catalogue_test/1, generates simple =~ assertions for the given text or list of texts.