mirror of
https://github.com/billz/raspap-webgui.git
synced 2025-03-01 10:31:47 +00:00
Added assets + dependencies
This commit is contained in:
Bill Zimmerman
74
bower_components/datatables-responsive/docs/option/responsive.breakpoints.xml
vendored
Executable file
74
bower_components/datatables-responsive/docs/option/responsive.breakpoints.xml
vendored
Executable file
@@ -0,0 +1,74 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<dt-option group="responsive">
|
||||
<name>responsive.breakpoints</name>
|
||||
<summary>Set the breakpoints for a Responsive instance</summary>
|
||||
<since>Responsive 1.0.0</since>
|
||||
|
||||
<type type="array">
|
||||
<description>
|
||||
<![CDATA[
|
||||
An array of objects, where each object contains two properties that describe each breakpoint:
|
||||
|
||||
* `name` - the breakpoint name allowing class targeting. This can be a single word, or append `\-[a-z]` to provide sub-breakpoints as the default does to allow, for example, tablet, tablet landscape or tablet portrait breakpoints.
|
||||
* `width` - the width (pixels) of the page viewport at which this breakpoint will apply. The value given is the maximum size at which this breakpoint will be applied, and it will be used until the next breakpoint is found. For example, if using the default breakpoints (above), the `tablet-l` breakpoint will be applied for `768 < x <= 1024` (where `x` is the viewport width).
|
||||
]]>
|
||||
</description>
|
||||
</type>
|
||||
|
||||
<default value="$.fn.dataTable.Responsive.breakpoints">
|
||||
The default breakpoints used by Responsive are defined by the static array defined in this object. This provides the ability to set common breakpoints that are used by all tables easily, if required.
|
||||
</default>
|
||||
|
||||
<description>
|
||||
The visibility of columns in a DataTable with Responsive enabled can be controlled by breakpoints and class names matching those breakpoints (and other logical operations) . This provides the ability to exactly control which columns in a table will be visible in each device type. [See the Responsive manual](/extensions/responsive/classes) for more information.
|
||||
|
||||
The breakpoints that are used by a Responsive instance are unique to that instance (i.e. each table) allowing different breakpoints to be set for different tables is needed.
|
||||
|
||||
The default breakpoints defined by `$.fn.dataTable.Responsive.breakpoints` is:
|
||||
|
||||
```js
|
||||
[
|
||||
{ name: 'desktop', width: Infinity },
|
||||
{ name: 'tablet-l', width: 1024 },
|
||||
{ name: 'tablet-p', width: 768 },
|
||||
{ name: 'mobile-l', width: 480 },
|
||||
{ name: 'mobile-p', width: 320 }
|
||||
]
|
||||
```
|
||||
|
||||
Note that if you define your own array of breakpoints, ordering of the breakpoints is not important. Responsive will automatically sort the array into its required internal order before using it.
|
||||
|
||||
Please note that as with all other configuration options for Responsive, this option is an extension to the [default set of DataTables options](/reference/init). This property should be set in the DataTables initialisation object.
|
||||
</description>
|
||||
|
||||
<example title="Set custom breakpoints in the DataTables initialisation"><![CDATA[
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: {
|
||||
breakpoints: [
|
||||
{ name: 'desktop', width: Infinity },
|
||||
{ name: 'tablet', width: 1024 },
|
||||
{ name: 'fablet', width: 768 },
|
||||
{ name: 'phone', width: 480 }
|
||||
]
|
||||
}
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
<example title="Set custom breakpoints using the defaults"><![CDATA[
|
||||
|
||||
$.fn.dataTable.Responsive.breakpoints = [
|
||||
{ name: 'desktop', width: Infinity },
|
||||
{ name: 'tablet', width: 1024 },
|
||||
{ name: 'fablet', width: 768 },
|
||||
{ name: 'phone', width: 480 }
|
||||
];
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: true
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
</dt-option>
|
||||
65
bower_components/datatables-responsive/docs/option/responsive.details.renderer.xml
vendored
Executable file
65
bower_components/datatables-responsive/docs/option/responsive.details.renderer.xml
vendored
Executable file
@@ -0,0 +1,65 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<dt-option group="responsive">
|
||||
<name>responsive.details.renderer</name>
|
||||
<summary>Define the renderer used to display the child rows</summary>
|
||||
<since>Responsive 1.0.0</since>
|
||||
|
||||
<type type="function">
|
||||
<signature>renderer( api, rowIdx )</signature>
|
||||
<parameter type="DataTables.Api" name="api">
|
||||
DataTables API instance for the table in question
|
||||
</parameter>
|
||||
<parameter type="integer" name="rowIdx">
|
||||
Row index for the row that the renderer is being asked to render. Use the `dt-api row()` and / or `dt-api cells()` methods to get information from the API about the row so the information can be rendered.
|
||||
</parameter>
|
||||
<returns type="boolean|string">
|
||||
Two values can be returned:
|
||||
|
||||
* `-type boolean` `false` - Do not display a child row
|
||||
* `-type string` - The information to be shown in the child row, including any required HTML.
|
||||
</returns>
|
||||
</type>
|
||||
|
||||
<default value="function">
|
||||
Function that will display the hidden information in a `-tag ul/li` list.
|
||||
</default>
|
||||
|
||||
<description>
|
||||
The information contained in the details rows that are displayed by Responsive are created through this function. By default it will create a `-tag ul/li` list showing the data from cells that are hidden, but you can provide a custom function that will create a child row containing whatever information you wish to display.
|
||||
|
||||
This function is executed for every child row in a table, and is run whenever the column visibility of the table changes.
|
||||
|
||||
Please note that as with all other configuration options for Responsive, this option is an extension to the [default set of DataTables options](/reference/init). This property should be set in the DataTables initialisation object.
|
||||
</description>
|
||||
|
||||
<example title="Custom renderer which displays the data that has been hidden in an HTML table"><![CDATA[
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: {
|
||||
details: {
|
||||
renderer: function ( api, rowIdx ) {
|
||||
// Select hidden columns for the given row
|
||||
var data = api.cells( rowIdx, ':hidden' ).eq(0).map( function ( cell ) {
|
||||
var header = $( api.column( cell.column ).header() );
|
||||
|
||||
return '<tr>'+
|
||||
'<td>'+
|
||||
header.text()+':'+
|
||||
'</td> '+
|
||||
'<td>'+
|
||||
api.cell( cell ).data()+
|
||||
'</td>'+
|
||||
'</tr>';
|
||||
} ).toArray().join('');
|
||||
|
||||
return data ?
|
||||
$('<table/>').append( data ) :
|
||||
false;
|
||||
}
|
||||
}
|
||||
}
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
</dt-option>
|
||||
64
bower_components/datatables-responsive/docs/option/responsive.details.target.xml
vendored
Executable file
64
bower_components/datatables-responsive/docs/option/responsive.details.target.xml
vendored
Executable file
@@ -0,0 +1,64 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<dt-option group="responsive">
|
||||
<name>responsive.details.target</name>
|
||||
<summary>Column / selector for child row display control when using `column` details type</summary>
|
||||
<since>Responsive 1.0.0</since>
|
||||
|
||||
<type type="number">
|
||||
<description>
|
||||
<![CDATA[
|
||||
Column index to which the show / hide control should be attached. This can be `>=0` to count columns from the left, or `<0` to count from the right.
|
||||
|
||||
Please note that the column defined here should have the class `-string control` added to it. This allows the Responsive CSS to display a control icon to the end user.
|
||||
]]>
|
||||
</description>
|
||||
</type>
|
||||
|
||||
<type type="string">
|
||||
<description>
|
||||
As a string, this option is used as a jQuery selector to determine what element(s) will activate the show / hide control for the details child rows. This provides the ability to use any element in a table - for example you can use the whole row, or a single `-tag img` element in the row.
|
||||
</description>
|
||||
</type>
|
||||
|
||||
<default value="0"/>
|
||||
|
||||
<description>
|
||||
When the `column` type is selected for the `r-init responsive.details.type` option, this option provides the ability to control what element in the table will activate the show / hide control in each row. This can be one of an column index, or a jQuery selector, as detailed below.
|
||||
|
||||
If the `inline` option is used for `r-init responsive.details.type` this option has no effect.
|
||||
|
||||
Please note that as with all other configuration options for Responsive, this option is an extension to the [default set of DataTables options](/reference/init). This property should be set in the DataTables initialisation object.
|
||||
</description>
|
||||
|
||||
<example title="Use the `column` control type and target the right most column"><![CDATA[
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: {
|
||||
details: {
|
||||
type: 'column',
|
||||
target: -1
|
||||
}
|
||||
},
|
||||
columnDefs: [ {
|
||||
className: 'control',
|
||||
orderable: false,
|
||||
targets: -1
|
||||
} ]
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
<example title="Use the whole row to show / hide the details row"><![CDATA[
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: {
|
||||
details: {
|
||||
type: 'column',
|
||||
target: 'tr'
|
||||
}
|
||||
}
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
</dt-option>
|
||||
47
bower_components/datatables-responsive/docs/option/responsive.details.type.xml
vendored
Executable file
47
bower_components/datatables-responsive/docs/option/responsive.details.type.xml
vendored
Executable file
@@ -0,0 +1,47 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<dt-option group="responsive">
|
||||
<name>responsive.details.type</name>
|
||||
<summary>Set the child row display control type</summary>
|
||||
<since>Responsive 1.0.0</since>
|
||||
|
||||
<type type="string">
|
||||
<description>
|
||||
The child row display type to use. This can be one of:
|
||||
|
||||
* `-string inline` - Use the first column to display the control element
|
||||
* `-string column` - Use a whole column to display the control element. Note that if used as a column type and the `target` option is set to be a column index, the class assigned to that column in the DataTable should be `control` to allow the CSS to display a visual show / hide control to the end user.
|
||||
</description>
|
||||
</type>
|
||||
|
||||
<default value="inline"/>
|
||||
|
||||
<description>
|
||||
Responsive has two built in methods of managing how the child row display control is shown to the end user:
|
||||
|
||||
* `inline` - where the first column in the table has additional padding added to it and the `:before` pseudo element is used to display the button.
|
||||
* `column` - where a whole column is dedicated to the show / hide control.
|
||||
|
||||
The `inline` style is useful if you already have a table that you quickly want to add Responsive to without changing its structure, while the `column` type can be useful if you don't want the first column's layout to be modified by the padding required to make space for the inline display.
|
||||
|
||||
Please note that as with all other configuration options for Responsive, this option is an extension to the [default set of DataTables options](/reference/init). This property should be set in the DataTables initialisation object.
|
||||
</description>
|
||||
|
||||
<example title="Use the `column` control type"><![CDATA[
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: {
|
||||
details: {
|
||||
type: 'column'
|
||||
}
|
||||
},
|
||||
columnDefs: [ {
|
||||
className: 'control',
|
||||
orderable: false,
|
||||
targets: 0
|
||||
} ],
|
||||
order: [ 1, 'asc' ]
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
</dt-option>
|
||||
53
bower_components/datatables-responsive/docs/option/responsive.details.xml
vendored
Executable file
53
bower_components/datatables-responsive/docs/option/responsive.details.xml
vendored
Executable file
@@ -0,0 +1,53 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<dt-option group="responsive">
|
||||
<name>responsive.details</name>
|
||||
<summary>Enable and configure the child rows shown by Responsive for collapsed tables</summary>
|
||||
<since>Responsive 1.0.0</since>
|
||||
|
||||
<type type="boolean">
|
||||
<description>
|
||||
As a `-type boolean` value, this option will enable and disable the child row display of Responsive. `false` will disable the child rows completely (columns will simply be removed from the disable and their content not be accessible other than through the DataTables API), while `true` will enable the child rows, using the default values defined by the object `$.fn.dataTables.Responsive.defaults.details`.
|
||||
</description>
|
||||
</type>
|
||||
|
||||
<type type="object">
|
||||
<description>
|
||||
When given as an object, the child row display of Responsive will be enabled, and configuration options can be given to extend or override the defaults.
|
||||
</description>
|
||||
</type>
|
||||
|
||||
<default value="true">
|
||||
Child rows will be disabled using the `inline` method (see `r-init responsive.details.type`).
|
||||
</default>
|
||||
|
||||
<description>
|
||||
Responsive has the ability to use DataTables' child rows feature to show information about any columns which have been removed from the display as a child row, which can be particularly useful for display complex information on small screen devices. Please see the [Responsive manual on the details rows](/extensions/responsive/details-rows) for further information.
|
||||
|
||||
This options provides the ability to configure how the details rows are handled by Responsive. In its simplest form as a boolean value, the details row display can be enabled or disabled, while as an object you have the ability to control how the rows are displayed and the control to show / hide the child rows.
|
||||
|
||||
Please note that as with all other configuration options for Responsive, this option is an extension to the [default set of DataTables options](/reference/init). This property should be set in the DataTables initialisation object.
|
||||
</description>
|
||||
|
||||
<example title="Disable the details row display"><![CDATA[
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: {
|
||||
details: false
|
||||
}
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
<example title="Set the `type` option for the details display"><![CDATA[
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: {
|
||||
details: {
|
||||
type: 'column'
|
||||
}
|
||||
}
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
</dt-option>
|
||||
49
bower_components/datatables-responsive/docs/option/responsive.xml
vendored
Executable file
49
bower_components/datatables-responsive/docs/option/responsive.xml
vendored
Executable file
@@ -0,0 +1,49 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<dt-option group="responsive">
|
||||
<name>responsive</name>
|
||||
<summary>Enable and configure the Responsive extension for DataTables</summary>
|
||||
<since>Responsive 1.0.0</since>
|
||||
|
||||
<type type="boolean">
|
||||
<description>
|
||||
As a boolean value this property will enable Responsive on the DataTable that is being created. `true` will enable Responsive, while `false` will not (even if the table has a class of `-string responsive` or `-string dt-responsive`.
|
||||
|
||||
This is a short-cut option to enable Responsive with the default configuration options. Customisations can be made by giving this parameter as an object, see below.
|
||||
</description>
|
||||
</type>
|
||||
|
||||
<type type="object">
|
||||
<description>
|
||||
If given as an object, Responsive will be enabled on the target DataTable, with the Responsive defaults (`$.fn.dataTable.Responsive.defaults`) extended, and potentially overwritten, by the options provided in this object. This is how Responsive can be configured on an individual table basis, or through the defaults.
|
||||
</description>
|
||||
</type>
|
||||
|
||||
<default value="undefined">
|
||||
Responsive will not be initialised by default
|
||||
</default>
|
||||
|
||||
<description>
|
||||
This option provides the ability to enable and configure Responsive for DataTables. In its simplest form as the boolean `true` it will enable Responsive with the default configuration options (as defined by `$.fn.dataTable.Responsive.defaults`). It can also be used as an object to provide custom configuration options as described below.
|
||||
|
||||
Please note that as with all other configuration options for Responsive, this option is an extension to the [default set of DataTables options](/reference/init). This property should be set in the DataTables initialisation object.
|
||||
</description>
|
||||
|
||||
<example title="Enable Responsive for a table"><![CDATA[
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: true
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
<example title="Enable Responsive with configuration options"><![CDATA[
|
||||
|
||||
$('#example').DataTable( {
|
||||
responsive: {
|
||||
details: false
|
||||
}
|
||||
} );
|
||||
|
||||
]]></example>
|
||||
|
||||
</dt-option>
|
||||
Reference in New Issue
Block a user