Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
AdminLTE renderer
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
IML Open Source
AdminLTE renderer
Commits
645574d4
Commit
645574d4
authored
11 months ago
by
Hahn Axel (hahn)
Browse files
Options
Downloads
Patches
Plain Diff
update docs; added examples
parent
a9d7b2ae
No related branches found
No related tags found
1 merge request
!18
Update renderer class
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/50_Forms/Input.md
+61
-5
61 additions, 5 deletions
docs/50_Forms/Input.md
docs/50_Forms/Select.md
+32
-4
32 additions, 4 deletions
docs/50_Forms/Select.md
docs/50_Forms/Textarea.md
+4
-3
4 additions, 3 deletions
docs/50_Forms/Textarea.md
with
97 additions
and
12 deletions
docs/50_Forms/Input.md
+
61
−
5
View file @
645574d4
...
@@ -31,21 +31,22 @@ Content:
...
@@ -31,21 +31,22 @@ Content:
Key | Description
Key | Description
--- | ---
--- | ---
hint | optional: Hint text above form field
label | label in front of the input element
label | label in front of the input element
name | name attribute for sending form data
name | name attribute for sending form data
value | value of the input field/ visible text; for checkbox and radio: the data to send when sending a form
value | value of the input field/ visible text; for checkbox and radio: the data to send when sending a form
### Example
### Example
s
#### Simple text input field
#### Simple text input field
```
php
```
php
$renderAdminLTE
->
getFormInput
(
array
(
$renderAdminLTE
->
getFormInput
(
[
'label'
=>
'Enter firstname'
,
'label'
=>
'Enter firstname'
,
'type'
=>
'text'
,
'type'
=>
'text'
,
'name'
=>
'firstname'
,
'name'
=>
'firstname'
,
'value'
=>
''
,
'value'
=>
''
,
)
);
]
);
```
```
You get a label, an input field wrapped in a
``<div class="form-group row">``
.
You get a label, an input field wrapped in a
``<div class="form-group row">``
.
...
@@ -72,8 +73,6 @@ With using append and prepend keys you can create gray boxes on left and right.
...
@@ -72,8 +73,6 @@ With using append and prepend keys you can create gray boxes on left and right.
For these input types you can use multiple elements.
For these input types you can use multiple elements.
You must wrap a bunch of input elements into
``<div class="form-group row">``
"manually".
You must wrap a bunch of input elements into
``<div class="form-group row">``
"manually".
```
php
```
php
echo
'<div class="form-group">'
echo
'<div class="form-group">'
.
$renderAdminLTE
->
getFormInput
([
.
$renderAdminLTE
->
getFormInput
([
...
@@ -91,3 +90,60 @@ echo '<div class="form-group">'
...
@@ -91,3 +90,60 @@ echo '<div class="form-group">'
.
'</div>'
.
'</div>'
;
;
```
```
#### Simple range slider
A simple slider:
```
php
$renderAdminLTE
->
getFormInput
([
'tag'
=>
'input'
,
'type'
=>
'range'
,
// <-----------
'min'
=>
0
,
'max'
=>
3
,
'step'
=>
1
,
'label'
=>
'Select 0..6'
,
]);
```
#### Range with labels
To add labels you need a datalist for the values and the labels to show, eg
```
html
<datalist
id=
"datalist-range"
>
<option
value=
"0"
label=
"no risc"
></option>
<option
value=
"1"
label=
"1"
></option>
<option
value=
"2"
label=
"2"
></option>
<option
value=
"3"
label=
"medium"
></option>
<option
value=
"4"
label=
"4"
></option>
<option
value=
"5"
label=
"5"
></option>
<option
value=
"6"
label=
"critical"
></option>
</datalist>
```
The id you ned to reference in the key "datalist":
```
php
$renderAdminLTE
->
getFormInput
([
'tag'
=>
'input'
,
'type'
=>
'range'
,
'min'
=>
0
,
'max'
=>
6
,
'step'
=>
1
,
'label'
=>
'Select 0..6'
,
'datalist'
=>
'datalist-range'
,
// <-----------
]);
```
For the datalist you need to extend your css:
```
css
datalist
{
display
:
flex
;
flex-direction
:
column
;
justify-content
:
space-between
;
writing-mode
:
vertical-lr
;
width
:
100%
;
}
```
This diff is collapsed.
Click to expand it.
docs/50_Forms/Select.md
+
32
−
4
View file @
645574d4
...
@@ -26,7 +26,7 @@ Styling for select tag:
...
@@ -26,7 +26,7 @@ Styling for select tag:
Key | Description
Key | Description
--- | ---
--- | ---
bootstrap-select | optional: use bootstrap-select pugin with live search (you need to load the plugin in your page)
bootstrap-select | optional: use bootstrap-select pugin with live search (you need to load the plugin in your page
- see example below
)
class | optional: additional css classes
class | optional: additional css classes
size | optional: visible option lines
size | optional: visible option lines
...
@@ -34,6 +34,7 @@ Content:
...
@@ -34,6 +34,7 @@ Content:
Key | Description
Key | Description
--- | ---
--- | ---
hint | optional: Hint text above form field
name | name attribute for sending form data
name | name attribute for sending form data
value | value of the input field/ visible text; for checkbox and radio: the data to send when sending a form
value | value of the input field/ visible text; for checkbox and radio: the data to send when sending a form
...
@@ -42,8 +43,7 @@ value | value of the input field/ visible text; for checkbox and radio: the d
...
@@ -42,8 +43,7 @@ value | value of the input field/ visible text; for checkbox and radio: the d
#### Simple select box
#### Simple select box
```
php
```
php
$renderAdminLTE
->
getFormSelect
(
array
$renderAdminLTE
->
getFormSelect
([
(
'label'
=>
'Select contact'
,
'label'
=>
'Select contact'
,
'name'
=>
'contact'
,
'name'
=>
'contact'
,
'tag'
=>
'select'
,
'tag'
=>
'select'
,
...
@@ -54,7 +54,7 @@ $renderAdminLTE->getFormSelect(array
...
@@ -54,7 +54,7 @@ $renderAdminLTE->getFormSelect(array
[
'value'
=>
'2'
,
'label'
=>
'Dick'
,
'selected'
=>
1
],
[
'value'
=>
'2'
,
'label'
=>
'Dick'
,
'selected'
=>
1
],
[
'value'
=>
'3'
,
'label'
=>
'Harry'
],
[
'value'
=>
'3'
,
'label'
=>
'Harry'
],
],
],
)
);
]
);
```
```
You get a label, an select box wrapped in a
``<div class="form-group row">``
.
You get a label, an select box wrapped in a
``<div class="form-group row">``
.
...
@@ -74,3 +74,31 @@ You get a label, an select box wrapped in a ``<div class="form-group row">``.
...
@@ -74,3 +74,31 @@ You get a label, an select box wrapped in a ``<div class="form-group row">``.
</div>
</div>
</div>
</div>
```
```
#### Select box with search field
We added support for the plugin
**bootstrap-select**
.
Get its files from the website and put it into a vendor directory.
Website:
<https://developer.snapappointments.com/bootstrap-select/>
In your html header section add its css and javascript:
```
html
<!-- bootstrap-select -->
<link
rel=
"stylesheet"
href=
"../vendor/bootstrap-select/1.13.18/css/bootstrap-select.min.css"
>
<script
src=
"../vendor/bootstrap-select/1.13.18/js/bootstrap-select.min.js"
></script>
```
In your select box add
``'bootstrap-select' => 1,``
:
```
php
$renderAdminLTE
->
getFormSelect
([
'label'
=>
'Select contact'
,
'name'
=>
'contact'
,
'tag'
=>
'select'
,
'size'
=>
1
,
'bootstrap-select'
=>
1
,
// <----------
'options'
=>
[
...
],
]);
```
This diff is collapsed.
Click to expand it.
docs/50_Forms/Textarea.md
+
4
−
3
View file @
645574d4
...
@@ -29,6 +29,7 @@ Content:
...
@@ -29,6 +29,7 @@ Content:
Key | Description
Key | Description
--- | ---
--- | ---
hint | optional: Hint text above form field
label | label in front of the Textarea element
label | label in front of the Textarea element
name | name attribute for sending form data
name | name attribute for sending form data
value | value of the textarea; visible text
value | value of the textarea; visible text
...
@@ -40,11 +41,11 @@ value | value of the textarea; visible text
...
@@ -40,11 +41,11 @@ value | value of the textarea; visible text
You get a label and a textare wrapped in a
``<div class="form-group row">``
.
You get a label and a textare wrapped in a
``<div class="form-group row">``
.
```
php
```
php
$renderAdminLTE
->
getFormTextarea
(
array
(
$renderAdminLTE
->
getFormTextarea
(
[
'label'
=>
'Enter text'
,
'label'
=>
'Enter text'
,
'name'
=>
'textdata'
,
'name'
=>
'textdata'
,
'value'
=>
'Here is some text...'
,
'value'
=>
'Here is some text...'
,
)
);
]
);
```
```
#### Html editor
#### Html editor
...
@@ -72,7 +73,7 @@ By adding ``'type' => 'html'`` an html editor will be rendered by adding a class
...
@@ -72,7 +73,7 @@ By adding ``'type' => 'html'`` an html editor will be rendered by adding a class
```
php
```
php
$renderAdminLTE
->
getFormTextarea
(
array
(
$renderAdminLTE
->
getFormTextarea
(
array
(
'type'
=>
'html'
,
'type'
=>
'html'
,
// <----------
'label'
=>
'Enter text'
,
'label'
=>
'Enter text'
,
'name'
=>
'textdata'
,
'name'
=>
'textdata'
,
'value'
=>
'Here is some text...'
,
'value'
=>
'Here is some text...'
,
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment