Frontmatter

If you are publishing this notebook on the web, you can set the parameters below to provide HTML metadata. This is useful for search engines and social media.

Packages
md"""
# Packages
"""
227 μs
begin
using PlutoDevMacros
end
44.7 ms
@frompackage "../.." begin
using ^.StructBondModule
using ^: ExtendedTableOfContents, Editable
using >.HypertextLiteral
using >.PlutoUI
end
❔
WARNING: could not import PlutoUI.@with_terminal into workspace#3
4.3 s
ExtendedTableOfContents()
111 ms
# html"""
# <style>
# main {
# margin-right: 350px !important;
# }
# </style>
# """
11.7 μs

StructBond
md"""
# StructBond
"""
201 μs

Generating automatic widgets for custom structs is quite straightforward with the aid of the @fielddata macro and the StructBond type.

The top-left arrow can be used to show-hide the field elements (useful inside a BondTable, shown below), while the green toggle on the top-right can be used to disable temporarily the synch between the JS widgets and the bond values in Pluto.
md"""
Generating automatic widgets for custom structs is quite straightforward with the aid of the `@fielddata` macro and the `StructBond` type.

The top-left arrow can be used to show-hide the field elements (useful inside a `BondTable`, shown below), while the green toggle on the top-right can be used to disable temporarily the synch between the JS widgets and the bond values in Pluto.
"""
320 μs
ASD

Markdown description, including $LaTeX$

 Field with HTML description Normal String Description

This field is special

 e
begin
"""
struct ASD
"""
Base.@kwdef struct ASD
a::Int
b::Int
c::String
"This field is _special_"
d::String
e::Int
end
@typeasfield String = TextField() # String fields with no struct-specific default will use this
@fielddata ASD begin
a = (md"Markdown description, including ``LaTeX``", Slider(1:10))
b = (@htl("<span>Field with <b>HTML</b> description</span>"), Scrubbable(1:10))
c = ("Normal String Description", TextField())
# d has no ASD-specific custom bond, so it will use the field docstring as description and the default String widget as widget
e = Slider(20:25) # No description, defaults to the fieldname as no docstring is present
end
asd_bond = @bind asd StructBond(ASD; description = "Custom Description")
end
93.9 ms
asd
48 ns

Default Type Widgets
md"""
## Default Type Widgets
"""
235 μs
BOH mah MAH a
begin
@kwdef struct MAH
a::Int
end
@kwdef struct BOH
mah::MAH
end
# This will make the default widget for an Int a Slider
@typeasfield Int = Slider(1:10)
# This will make the default widget for fields of type ASD a popout that wraps a StructBond{ASD}
@popoutasfield MAH
@bind boh StructBond(BOH)
end
231 ms
boh
60 ns

@NTBond
md"""
# @NTBond
"""
195 μs

Sometimes custom structs are not needed and it would be useful to just use the same nice bond structure of StructBond to simply create arbitrary NamedTuples.

This is possible with the convenience macro @NTBond which can be called as shown below to create a nice display for an interactive bond creating an arbitrary NamedTuple.

The macro simply create a StructBond wrapping the desired NamedTuple type.
md"""
Sometimes custom structs are not needed and it would be useful to just use the same nice bond structure of `StructBond` to simply create arbitrary NamedTuples.

This is possible with the convenience macro `@NTBond` which can be called as shown below to create a nice display for an interactive bond creating an arbitrary NamedTuple.

The macro simply create a `StructBond` wrapping the desired NamedTuple type.
"""
353 μsnt_bond
My Fancy NTuple Description

Bold field

 c
nt_bond = @bind nt @NTBond "My Fancy NTuple" begin
a = ("Description", Slider(1:10))
b = (md"**Bold** field", Slider(1:10))
c = Slider(1:10) # No description, defaults to the name of the field
end
391 ms
nt
51 ns

@BondsList
md"""
# @BondsList
"""
257 μs

In some cases, one does not want to have a single bond wrapping either a Structure or a NamedTuple because single independent bonds are more convenient.

@BondsList is a convenience macro to create an object of type BondsList which simply allow to add a description to separate bonds and group them all together in a table-like format equivalent to those of StructBond.

Note

Unlike StructBond, a BondsList is already composed of bond created with @bind and it just groups them up with a description. The output of @BondsList is not supposed to be bound to a variable using @bind.
The bonds grouped in a BondsList still act and update independently from one another.

See the example below for understanding the synthax. The header of a BondsList is shown in an orange background to easily differentiate it from StructBond.
md"""
In some cases, one does not want to have a single bond wrapping either a Structure or a NamedTuple because single independent bonds are more convenient.

`@BondsList` is a convenience macro to create an object of type `BondsList` which simply allow to add a description to separate bonds and group them all together in a table-like format equivalent to those of `StructBond`.

!!! note
Unlike `StructBond`, a BondsList is already composed of bond created with `@bind` and it just groups them up with a description. The output of `@BondsList` is not supposed to be bound to a variable using `@bind`.\
The bonds grouped in a BondsList still act and update independently from one another.

See the example below for understanding the synthax. The header of a BondsList is shown in an orange background to easily differentiate it from `StructBond`.
"""
9.5 msbl
My Group of Bonds Frequency [GHz]

Altitude $h$ [m]
bl = @BondsList "My Group of Bonds" let tv = PlutoUI.Experimental.transformed_value
# We use transformed_value to translate GHz to Hz in the bound variable `freq`
"Frequency [GHz]" = @bind freq tv(x -> x * 1e9, Editable(20; suffix = " GHz"))
md"Altitude ``h`` [m]" = @bind alt Scrubbable(100:10:200)
end
185 ms
1.5e10
freq
43 ns
160
alt
47 ns

Popout
md"""
# Popout
"""
233 μs

The structures above can also be used nested within one another. To facilitate accessing nested structures, one can use the Popout type.

In its simple form, you can give an instance of a StructBond, a bond wrapping a StructBond or a BondsList as input to Popout to create a table that is hidden behind a popup window. If an instance present, but you want a custom type for which you have defined custom bonds and descriptions with @fielddata to appear as popout, you can use the function popoutwrap(TYPE) to generate a small icon which hides a popup containing the StructBond of the provided type TYPE.

The StructBond table appears on hover upon the icon, can be made fixed by clicking on the icon and can then be moved around or resized. A double click on the header of the popout hides it again:
md"""
The structures above can also be used nested within one another. To facilitate accessing nested structures, one can use the `Popout` type.

In its simple form, you can give an instance of a StructBond, a bond wrapping a StructBond or a BondsList as input to Popout to create a table that is hidden behind a popup window.
If an instance present, but you want a custom type for which you have defined custom bonds and descriptions with `@fielddata` to appear as popout, you can use the function `popoutwrap(TYPE)` to generate a small icon which hides a popup containing the `StructBond` of the provided type `TYPE`.

The StructBond table appears on hover upon the icon, can be made fixed by clicking on the icon and can then be moved around or resized.
A double click on the header of the popout hides it again:
"""
464 μs
begin
Base.@kwdef struct LOL
a::Int
b::Int
end
@fielddata LOL begin
a = (md"Wonder!", Slider(1:10))
b = (@htl("<span>Field B</span>"), Scrubbable(1:10))
end
end
4.7 ms
LOL

Wonder!

 Field B
@bind lol_pop popoutwrap(LOL)
90.9 ms
lol_pop
50 ns

The ability to also wrap pre-existing bonds around StructBonds is convenient for organizing the various bonds one have in a BondsList or BondTable

As an example, one can create a BondsList containing the two StructBond bonds generated at the beginning of this notebook with the follwing code.
md"""
The ability to also wrap pre-existing bonds around StructBonds is convenient for organizing the various bonds one have in a `BondsList` or `BondTable`

As an example, one can create a `BondsList` containing the two `StructBond` bonds generated at the beginning of this notebook with the follwing code.
"""
309 μsblc
Popout Container Structure ASD ASD

Markdown description, including $LaTeX$

 Field with HTML description Normal String Description

This field is special

 e NamedTuple NamedTuple Description

Bold field

 c
blc = @BondsList "Popout Container" begin
"Structure ASD" = Popout(asd_bond)
"NamedTuple" = Popout(nt_bond)
end
3.8 μs
asd
46 ns
nt
63 ns

BondTable
md"""
# BondTable
"""
207 μs

The final convenience structure provided by this module is the BondTable. It can be created to group a list of bonds in a floating table that stays on the left side of the notebook (similar to the TableOfContents of PlutoUI) and can be moved around and resized or hidden for convenience.

The BondTable is intended to be used either with bonds containing StructBond or with BondsList. Future types with similar structure will also be added.

Here is an example of a bondtable containing all the examples of this notebook.
md"""
The final convenience structure provided by this module is the `BondTable`. It can be created to group a list of bonds in a floating table that stays on the left side of the notebook (similar to the TableOfContents of PlutoUI) and can be moved around and resized or hidden for convenience.

The BondTable is intended to be used either with bonds containing `StructBond` or with `BondsList`. Future types with similar structure will also be added.

Here is an example of a bondtable containing all the examples of this notebook.
"""
401 μs
My Bonds ASD

Markdown description, including $LaTeX$

 Field with HTML description Normal String Description

This field is special

 e NamedTuple Description

Bold field

 c My Group of Bonds Frequency [GHz]

Altitude $h$ [m]

 Popout Container Structure ASD ASD

Markdown description, including $LaTeX$

 Field with HTML description Normal String Description

This field is special

 e NamedTuple NamedTuple Description

Bold field

 c
BondTable([
asd_bond,
nt_bond,
bl,
blc
]; description = "My Bonds")
27.2 μs
nt
52 ns
asd
49 ns
1.5e10
freq
47 ns
160
alt
59 ns
Reload @frompackage