new bootstrap4(ui)
- Description:
Bootstrap V4 Tools. These tools are used when
BOOTSTRAP_VERSION
system parameter's value is4
Parameters:
Name | Type | Description |
---|---|---|
ui |
Main UI controller |
Methods
accordion(ctn)
- Description:
Manage collapsible panels as accordion
Parameters:
Name | Type | Description |
---|---|---|
ctn |
Object | Container of panels .collapse |
actionButton(a, o, rowid, onClick, minified)
- Description:
Button of action
Parameters:
Name | Type | Description |
---|---|---|
a |
Action |
|
o |
Business Object |
|
rowid |
Optional row ID |
|
onClick |
Handler |
|
minified |
Hide label? |
actionIcon(p)
- Description:
Icon button
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
p |
Object | Optional parameters Properties
|
actionPlus(items, right, dropUp)
- Description:
Create a 'plus' button
Parameters:
Name | Type | Description |
---|---|---|
items |
Array of item (li) |
|
right |
Align popup to the right of button |
|
dropUp |
On top? |
addTab(t, tab, active)
- Description:
Add a tab
Parameters:
Name | Type | Description |
---|---|---|
t |
jQuery | Existing tabs |
tab |
Object | Tab options |
active |
boolean | Activate this tab? |
alert(h, level)
- Description:
Simple alert content
Parameters:
Name | Type | Description |
---|---|---|
h |
HTML content |
|
level |
Optional |
button(p)
- Description:
Create a button
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
p |
Object | Options Properties
|
buttonHelp(name, help, title, btn)
- Description:
Return a simple help icon with a popover or a dialog when help is too long
Parameters:
Name | Type | Description |
---|---|---|
name |
string | Button name |
help |
string | Text or html |
title |
string | Optional title of dialog |
btn |
jQuery | Optional button to complete |
card()
- Description:
card/panel alias
check(d)
- Description:
Simple checkbox or radio
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
d |
Object | Options Properties
|
col(size, content)
- Description:
Simple column
Parameters:
Name | Type | Description |
---|---|---|
size |
string | Media-width: short syntax 'md-5' or long syntax 'col-lg-4 col-md-8', default 'col-12', 'xs-' is supported |
content |
jQuery | Array.<jQuery> | Optional content or array of contents |
compat(d)
- Description:
Backward compatibility with V3: grid "xs-"
Parameters:
Name | Type | Description |
---|---|---|
d |
jQueyy | Content to fix |
danger(h)
- Description:
Simple error
Parameters:
Name | Type | Description |
---|---|---|
h |
Content |
destroy(ctn)
- Description:
Destroy bootstrap elements
Parameters:
Name | Type | Description |
---|---|---|
ctn |
form container |
dialog(p)
- Description:
Dialog box
Parameters:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
p |
Object | String content or object Properties
|
dialogClose(dlg, cbk)
- Description:
Close the dialog box
Parameters:
Name | Type | Description |
---|---|---|
dlg |
string | jQuery | name or modal, undefined = close the top dialog if unset, "all" = close all |
cbk |
function | optional callback when dialog is closed |
displayField()
- Description:
Field rendering. Deprecated use
$ui.view.getField(ctn, o, f, index).ui.draw()
- Deprecated:
- Yes
displayFieldSearch()
- Description:
Field search rendering
displayLinkSearch()
- Description:
Link search rendering (for N,N pillbox)
dropdown(elt, btn, items, right, dropUp, caret)
- Description:
Create a dropdown button
Parameters:
Name | Type | Description |
---|---|---|
elt |
Optional left side of button |
|
btn |
The button to convert to dropdown |
|
items |
List of |
|
right |
Align popup on right side of button |
|
dropUp |
True to drop on the top of button |
|
caret |
Display a caret on the right side of button? |
dropup(elt, btn, items, right)
- Description:
Create a dropup button
Parameters:
Name | Type | Description |
---|---|---|
elt |
Optional left side of button |
|
btn |
Toggle button |
|
items |
List of |
|
right |
Align popup on right side of button |
focus(el)
- Description:
Focus one element and active/expand tabs/collapsed parents
Parameters:
Name | Type | Description |
---|---|---|
el |
jQuery | Element to focus |
form(p)
- Description:
Simple form
Parameters:
Name | Type | Description |
---|---|---|
p |
Parameters |
formGroup(name, label, inp, msg, suggestCallback)
- Description:
Form group of input
Parameters:
Name | Type | Description |
---|---|---|
name |
string | Group name |
label |
string | Optional label or text |
inp |
string | jQuery | Input group |
msg |
Object | Optional backend message |
suggestCallback |
function | a suggestion callback, sets new value, returns old value |
formGroupSearch(cls, label, input)
- Description:
Form group for search form
Parameters:
Name | Type | Description |
---|---|---|
cls |
Class |
|
label |
Text |
|
input |
Input |
getDialog(dlg)
- Description:
Find a visible dialog
Parameters:
Name | Type | Description |
---|---|---|
dlg |
string | optional dialog, name or "all", or returns the top level dialog if unset |
getTabActive(t)
- Description:
Get the active tab anchor with data
Parameters:
Name | Type | Description |
---|---|---|
t |
jQuery | Tabs |
getTabPane(t, index)
- Description:
Get a tab container
Parameters:
Name | Type | Description |
---|---|---|
t |
jQuery | Tabs |
index |
number | string | Tab index or tab data-key |
getTabs(t, s)
- Description:
Get the tab anchors with data
Parameters:
Name | Type | Description |
---|---|---|
t |
jQuery | Tabs |
s |
string | Optional anchor selector |
getTemplate()
- Description:
Get template for BSv4
getVersion()
- Description:
Bootstrap full version (e.g.
4.3.1
)
help(h)
- Description:
Simple help
Parameters:
Name | Type | Description |
---|---|---|
h |
Content as safe HTML (any script is ignored) |
hideTooltips(ctn)
- Description:
Hide all (remaining) tooltips and popovers
Parameters:
Name | Type | Description |
---|---|---|
ctn |
optional container |
icon(name, cls)
- Description:
Simple icon (deprecated: use $view.icon directly)
- Deprecated:
- Yes
Parameters:
Name | Type | Description |
---|---|---|
name |
string | Icon name or prefixed by fas/ far/ |
cls |
string | Optional class name |
image(src, onload, onerror)
- Description:
Get responsive image (.img-fluid)
Parameters:
Name | Type | Description |
---|---|---|
src |
string | Source |
onload |
function | optional callback |
onerror |
function | optional error callback |
init(ctn)
- Description:
Init a container with bootstrap elements
Parameters:
Name | Type | Description |
---|---|---|
ctn |
form container |
initTooltips(ctn)
- Description:
Init all tooltips and popovers
Parameters:
Name | Type | Description |
---|---|---|
ctn |
optional container |
input(a)
- Description:
Input with attributes
Parameters:
Name | Type | Description |
---|---|---|
a |
Object with attributes |
inputGroup(inp, addons, prefix)
- Description:
Create an input group with addons actions
Parameters:
Name | Type | Description |
---|---|---|
inp |
jQuery | Input element |
addons |
Array | Optional array of |
prefix |
string | jQuery | Optional prefix |
isDialogModal(dlg)
- Description:
Is the dialog modal (no keyboard ESC and no close button) ?
Parameters:
Name | Type | Description |
---|---|---|
dlg |
string | optional name or top level dialog if unset |
load()
- Description:
Load bootstrap libs
message(m)
- Description:
Inlined message alert
Parameters:
Name | Type | Description |
---|---|---|
m |
String or |
panel(params)
- Description:
Simple panel (implemented with card)
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
Object | Parameters Properties
|
progressBar(id, p)
- Description:
Progress bar
Parameters:
Name | Type | Description |
---|---|---|
id |
string | $ | Progress div or id |
p |
number | value in percent [0..100] |
radio(d)
- Description:
Simple radio
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
d |
Object | Options Properties
|
ready()
- Description:
Home is displayed
removeTab(t, index, prev)
- Description:
Remove a tab
Parameters:
Name | Type | Description |
---|---|---|
t |
jQuery | Tabs |
index |
number | string | Tab index or tab data-key |
prev |
boolean | Click on previous (or next) tab if exists |
row(cols)
- Description:
Create a row with columns
Parameters:
Name | Type | Description |
---|---|---|
cols |
Array of columns |
select(a, o)
- Description:
Select with options
Parameters:
Name | Type | Description |
---|---|---|
a |
Object with attributes |
|
o |
Array of |
setTabActive(t)
- Description:
Set the active tab anchor
Parameters:
Name | Type | Description |
---|---|---|
t |
jQuery | Tabs |
setTabContent(t, index, content)
- Description:
Set a tab content
Parameters:
Name | Type | Description |
---|---|---|
t |
jQuery | Tabs |
index |
number | string | Tab index or tab data-key |
content |
string | HTML content |
showTab(t, id, show)
- Description:
Show/hide a tab in a tabs and ensure to activate a visible tab
Parameters:
Name | Type | Description |
---|---|---|
t |
jQuery | Tabs |
id |
string | Tab ID |
show |
boolean | False to hide the tab |
showTabs(t, fn, cls)
- Description:
Show/Hide empty tabs and ensure to activate a non-empty tab
Parameters:
Name | Type | Description |
---|---|---|
t |
jQuery | Tabs |
fn |
function | Optional function to test if a tab is visible |
cls |
string | Class 'hidden' or 'empty' to hide the tab |
Returns:
True if the tabs is visible = contains something visible
simpleFormGroup(id, label, val, arg, col, addon, disabled)
- Description:
Simple form group with boolean, select or text field
Parameters:
Name | Type | Description |
---|---|---|
id |
input id |
|
label |
field label |
|
val |
field value |
|
arg |
true for boolean, array of code/value, or 'textarea' |
|
col |
optional size from 1 to 12 |
|
addon |
optional addon |
|
disabled |
false to disable input |
spanIcon(p)
- Description:
Icon button
Parameters:
Name | Type | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
p |
Object | Optional parameters Properties
|
success(h)
- Description:
Simple info
Parameters:
Name | Type | Description |
---|---|---|
h |
Content |
tabBadge(tab, val)
- Description:
Add/Replace a badge counter to tab
Parameters:
Name | Type | Description |
---|---|---|
tab |
Tab href or any tab content element |
|
val |
Badge value (no badge if null) |
tabs(params)
- Description:
Simple tabs
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
Object | Parameters Properties
|
toggleChecked(elts)
- Description:
Toogle checked class on an array of checkboxes/radio buttons's parent element
Parameters:
Name | Type | Description |
---|---|---|
elts |
Array | Array of checkboxes/radio buttons |
tooltip(e, title, placement, html)
- Description:
Add a tooltip to element
Parameters:
Name | Type | Description |
---|---|---|
e |
Element |
|
title |
Text or html |
|
placement |
Optional, default 'bottom' |
|
html |
HTML Title? |
warning(h)
- Description:
Simple warning
Parameters:
Name | Type | Description |
---|---|---|
h |
Content |