Skip to content

Commit

Permalink
Generar documentación de la API
Browse files Browse the repository at this point in the history
  • Loading branch information
xaabi6 committed Nov 4, 2024
1 parent 95fff2c commit f002913
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 31 deletions.
3 changes: 2 additions & 1 deletion doc/api/rup.select.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Opciones por defecto de configuración del componente.
| [typeAhead] | <code>number</code> | <code>false</code> | Especifica en milisegundos el tiempo de espera que toma el componente antes de procesar los eventos de escritura realizados por el usuario. |
| [legacyWrapMode] | <code>number</code> | <code>false</code> | Determina si se emplea el método obsoleto a la hora de empaquetar en objetos json los elementos seleccionados. Su propósito es mantener la retrocompatibilidad. |
| [autocomplete] | <code>boolean</code> | <code>false</code> | Habilita la funcionalidad de autocompletado, permitiendo hacer búsquedas sobre los resultados. |
| [spaceEnable] | <code>boolean</code> | <code>true</code> | Habilita la funcionalidad de búsquedas con barra espaciadora. |

<a name="module_rup_select..getRupValue"></a>

Expand Down Expand Up @@ -364,7 +365,7 @@ Permite consultar y modificar la configuración del componente.

**Example**
```js
// Establecer una propiedad$("#idSelect").rup_select("option", "minLegth", 2);// Establecer varias propiedad$("#idSelect").rup_select("option", {minLegth:2, delay:1000});
// Establecer una propiedad$("#idSelect").rup_select("option", "minimumResultsForSearch", 2);// Establecer varias propiedad$("#idSelect").rup_select("option", {minimumResultsForSearch:2, delay:1000});
```
<a name="module_rup_select..open"></a>

Expand Down
40 changes: 10 additions & 30 deletions doc/api/rup.table.buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,10 @@ Buttons for DataTables

* [rup.table.buttons](#module_rup.table.buttons)
* [~Buttons(dt, config)](#module_rup.table.buttons..Buttons)
* [~action(Button)](#module_rup.table.buttons..action) ⇒ <code>function</code>
* [~action(node, action)](#module_rup.table.buttons..action) ⇒ <code>Buttons</code>
* [~active(node, [flag])](#module_rup.table.buttons..active) ⇒ <code>Buttons</code>
* [~add(config, [idx], [draw])](#module_rup.table.buttons..add) ⇒ <code>Buttons</code>
* [~collectionRebuild()](#module_rup.table.buttons..collectionRebuild)
* [~collectionRebuild(node, [newButtons])](#module_rup.table.buttons..collectionRebuild)
* [~container()](#module_rup.table.buttons..container) ⇒ <code>jQuery</code>
* [~disable(node)](#module_rup.table.buttons..disable) ⇒ <code>Buttons</code>
* [~destroy()](#module_rup.table.buttons..destroy) ⇒ <code>Buttons</code>
Expand All @@ -25,7 +24,6 @@ Buttons for DataTables
* [~node([node])](#module_rup.table.buttons..node) ⇒ <code>jQuery</code>
* [~processing(node, flag)](#module_rup.table.buttons..processing) ⇒ <code>boolean</code> \| <code>Buttons</code>
* [~remove(node)](#module_rup.table.buttons..remove) ⇒ <code>Buttons</code>
* [~text(node)](#module_rup.table.buttons..text) ⇒ <code>string</code>
* [~text(node, label)](#module_rup.table.buttons..text) ⇒ <code>Buttons</code>
* [~_constructor()](#module_rup.table.buttons.._constructor)
* [~_addKey(conf)](#module_rup.table.buttons.._addKey)
Expand Down Expand Up @@ -73,18 +71,6 @@ Botones

<a name="module_rup.table.buttons..action"></a>

### rup.table.buttons~action(Button) ⇒ <code>function</code>
Get the action of a button

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Since**: UDA 3.4.0

| Param | Type | Description |
| --- | --- | --- |
| Button | <code>int</code> \| <code>string</code> | index |

<a name="module_rup.table.buttons..action"></a>

### rup.table.buttons~action(node, action) ⇒ <code>Buttons</code>
Set the action of a button

Expand Down Expand Up @@ -128,10 +114,17 @@ Add a new button

<a name="module_rup.table.buttons..collectionRebuild"></a>

### rup.table.buttons~collectionRebuild()
Clear buttons from a collection and then insert new buttons
### rup.table.buttons~collectionRebuild(node, [newButtons])
Clear buttons from a collection and then insert new buttons.

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Since**: UDA 6.1.0

| Param | Type | Description |
| --- | --- | --- |
| node | <code>node</code> | Button element |
| [newButtons] | <code>array</code> | New buttons array |

<a name="module_rup.table.buttons..container"></a>

### rup.table.buttons~container() ⇒ <code>jQuery</code>
Expand Down Expand Up @@ -237,19 +230,6 @@ Remove a button.

<a name="module_rup.table.buttons..text"></a>

### rup.table.buttons~text(node) ⇒ <code>string</code>
Get the text for a button

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Returns**: <code>string</code> - Button text
**Since**: UDA 3.4.0

| Param | Type | Description |
| --- | --- | --- |
| node | <code>int</code> \| <code>string</code> | Button index |

<a name="module_rup.table.buttons..text"></a>

### rup.table.buttons~text(node, label) ⇒ <code>Buttons</code>
Set the text for a button

Expand Down

0 comments on commit f002913

Please sign in to comment.