mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2025-12-11 12:01:23 +01:00
11057faac8
* Move documentation files to new folder * Documentation prototype Create a documentation class and views * Remove whitespace and add functions returns * Remove Google fonts * Remove return string * Phpcbf corrections * Phpcdf with good ruleset * add return null * resolve conflict with test_arrays.php * Return void for print functions * WIP progress bar * Add seteventmessage documentation for ui/ux * Add translations * Delete is of button * Clean titles * Change name of file event-message.php * Update before moving and rename files * Remove fr_FR lang file (all in en_US for the moment) * Add some css * Menu definition updated * Add jQuery, lib_head.js and lib_foot.js * Add missing button * Add missing button * move ui doc files * Remove old documentation files * Reupload test_arrays.php * Rename lang file * Move lang file * add htmlhead * Add parameter comment * Update tables.php * Update uxdocumentation.lang * Update tables.php * Update uxdocumentation.lang * Update progress-bars.php * Update tables.php --------- Co-authored-by: John BOTELLA <68917336+thersane-john@users.noreply.github.com> Co-authored-by: atm-lena <lena.papazian@atm-consulting.fr> Co-authored-by: Laurent Destailleur <eldy@destailleur.fr>
265 lines
11 KiB
PHP
265 lines
11 KiB
PHP
<?php
|
|
/*
|
|
* Copyright (C) 2024 Anthony Damhet <a.damhet@progiseize.fr>
|
|
*
|
|
* This program and files/directory inner it is free software: you can
|
|
* redistribute it and/or modify it under the terms of the
|
|
* GNU Affero General Public License (AGPL) as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU AGPL for more details.
|
|
*
|
|
* You should have received a copy of the GNU AGPL
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
*/
|
|
|
|
$res=0;
|
|
if (! $res && file_exists("../../main.inc.php")) : $res=@include '../../main.inc.php';
|
|
endif;
|
|
if (! $res && file_exists("../../../main.inc.php")) : $res=@include '../../../main.inc.php';
|
|
endif;
|
|
if (! $res && file_exists("../../../../main.inc.php")) : $res=@include '../../../../main.inc.php';
|
|
endif;
|
|
|
|
// Protection if external user
|
|
if ($user->socid > 0) : accessforbidden();
|
|
endif;
|
|
|
|
// Includes
|
|
dol_include_once('admin/tools/ui/class/documentation.class.php');
|
|
|
|
// Load documentation translations
|
|
$langs->load('uxdocumentation');
|
|
|
|
//
|
|
$documentation = new Documentation($db);
|
|
|
|
// Output html head + body - Param is Title
|
|
$documentation->docHeader('Progress-bars');
|
|
|
|
// Set view for menu and breadcrumb
|
|
// Menu must be set in constructor of documentation class
|
|
$documentation->view = array('Components','Progress');
|
|
|
|
// Output sidebar
|
|
$documentation->showSidebar(); ?>
|
|
|
|
<div class="doc-wrapper">
|
|
|
|
<?php $documentation->showBreadCrumb(); ?>
|
|
|
|
<div class="doc-content-wrapper">
|
|
|
|
<h1 class="documentation-title"><?php echo $langs->trans('DocProgressBarsTitle'); ?></h1>
|
|
<p class="documentation-text"><?php echo $langs->trans('DocProgressBarsMainDescription'); ?></p>
|
|
|
|
<!-- Summary -->
|
|
<?php $documentation->showSummary(); ?>
|
|
|
|
<!-- Basic usage -->
|
|
<div class="documentation-section" id="progresse-section-basic-usage">
|
|
<h2 class="documentation-title"><?php echo $langs->trans('DocBasicUsage'); ?></h2>
|
|
<p class="documentation-text"><?php echo $langs->trans('DocProgressBarsDescription'); ?></p>
|
|
<div class="documentation-example">
|
|
|
|
<?php echo 'Xss'; ?>
|
|
<div class="progress xxs spaced" title="10%">
|
|
<div class="progress-bar" role="progressbar" style="width: 10%" aria-valuenow="10" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
|
|
<?php echo 'Xs'; ?>
|
|
<div class="progress xs spaced" title="20%">
|
|
<div class="progress-bar" role="progressbar" style="width: 20%" aria-valuenow="20" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
|
|
<?php echo 'Sm'; ?>
|
|
<div class="progress sm spaced" title="40%">
|
|
<div class="progress-bar" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
|
|
<?php echo $langs->trans('Default'); ?>
|
|
<div class="progress" title="80%">
|
|
<div class="progress-bar" role="progressbar" style="width: 80%" aria-valuenow="80" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
</div>
|
|
|
|
<?php
|
|
$lines = array(
|
|
'<div class="progress xxs" title="10%">',
|
|
' <div class="progress-bar" role="progressbar" style="width: 10%" aria-valuenow="10" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress xs" title="20%">',
|
|
' <div class="progress-bar" role="progressbar" style="width: 20%" aria-valuenow="20" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress sm" title="40%">',
|
|
' <div class="progress-bar" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress" title="80%">',
|
|
' <div class="progress-bar" role="progressbar" style="width: 80%" aria-valuenow="80" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
);
|
|
echo $documentation->showCode($lines); ?>
|
|
|
|
<p class="documentation-text"><?php echo $langs->trans('DocProgressCanBeSpaced'); ?></p>
|
|
<div class="documentation-example">
|
|
<div class="progress spaced" title="40%">
|
|
<div class="progress-bar" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
</div>
|
|
|
|
<?php
|
|
$lines = array(
|
|
'<div class="progress spaced" title="40%">',
|
|
' <div class="progress-bar" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
);
|
|
echo $documentation->showCode($lines); ?>
|
|
|
|
</div>
|
|
|
|
|
|
<!-- Colors usage -->
|
|
<div class="documentation-section" id="progress-section-color">
|
|
<h2 class="documentation-title"><?php echo $langs->trans('DocColorVariants'); ?></h2>
|
|
<p class="documentation-text"><?php echo $langs->trans('DocColorVariantsDesc'); ?></p>
|
|
<div class="documentation-example">
|
|
<div class="progress spaced" title="40%">
|
|
<div class="progress-bar progress-bar-success" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
<div class="progress spaced" title="40%">
|
|
<div class="progress-bar progress-bar-warning" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
<div class="progress spaced" title="40%">
|
|
<div class="progress-bar progress-bar-info" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
<div class="progress spaced" title="40%">
|
|
<div class="progress-bar progress-bar-danger" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
</div>
|
|
|
|
<?php
|
|
$lines = array(
|
|
'<div class="progress" title="40%">',
|
|
' <div class="progress-bar progress-bar-success" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress" title="40%">',
|
|
' <div class="progress-bar progress-bar-warning" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress" title="40%">',
|
|
' <div class="progress-bar progress-bar-info" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress" title="40%">',
|
|
' <div class="progress-bar progress-bar-danger" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
|
|
);
|
|
echo $documentation->showCode($lines); ?>
|
|
</div>
|
|
|
|
|
|
<!-- Striped usage -->
|
|
<div class="documentation-section" id="progresse-section-stripped">
|
|
<h2 class="documentation-title"><?php echo $langs->trans('DocStripedVariants'); ?></h2>
|
|
<p class="documentation-text"><?php echo $langs->trans('DocStripedVariantsDesc'); ?></p>
|
|
|
|
<div class="documentation-example">
|
|
<div class="progress spaced progress-striped" title="40%">
|
|
<div class="progress-bar progress-bar-success" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
<div class="progress spaced progress-striped" title="40%">
|
|
<div class="progress-bar progress-bar-warning" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
<div class="progress spaced progress-striped" title="40%">
|
|
<div class="progress-bar progress-bar-info" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
<div class="progress spaced progress-striped" title="40%">
|
|
<div class="progress-bar progress-bar-danger" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
</div>
|
|
|
|
<?php
|
|
$lines = array(
|
|
'<div class="progress progress-striped" title="40%">',
|
|
' <div class="progress-bar progress-bar-success" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress progress-striped" title="40%">',
|
|
' <div class="progress-bar progress-bar-warning" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress progress-striped" title="40%">',
|
|
' <div class="progress-bar progress-bar-info" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress progress-striped" title="40%">',
|
|
' <div class="progress-bar progress-bar-danger" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
|
|
);
|
|
echo $documentation->showCode($lines); ?>
|
|
</div>
|
|
<!-- -->
|
|
|
|
|
|
<!-- other usage -->
|
|
<div class="documentation-section" id="progresse-section-stripped">
|
|
<h2 class="documentation-title"><?php echo $langs->trans('DocOtherVariants'); ?></h2>
|
|
<p class="documentation-text"><?php echo $langs->trans('DocOtherVariantsDesc'); ?></p>
|
|
|
|
<div class="documentation-example">
|
|
.progress-bar-consumed
|
|
<div class="progress spaced progress-bar-consumed" title="40%">
|
|
<div class="progress-bar" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
.progress-bar-consumed-late
|
|
<div class="progress spaced progress-bar-consumed" title="40%">
|
|
<div class="progress-bar" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>
|
|
</div>
|
|
</div>
|
|
|
|
<?php
|
|
$lines = array(
|
|
'<div class="progress progress-striped" title="40%">',
|
|
' <div class="progress-bar progress-bar-success" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress progress-striped" title="40%">',
|
|
' <div class="progress-bar progress-bar-warning" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress progress-striped" title="40%">',
|
|
' <div class="progress-bar progress-bar-info" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
'<div class="progress progress-striped" title="40%">',
|
|
' <div class="progress-bar progress-bar-danger" role="progressbar" style="width: 40%" aria-valuenow="40" aria-valuemin="0" aria-valuemax="100"></div>',
|
|
'</div>',
|
|
'',
|
|
|
|
);
|
|
echo $documentation->showCode($lines); ?>
|
|
</div>
|
|
<!-- -->
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<?php
|
|
// Output close body + html
|
|
$documentation->docFooter();
|
|
?>
|