@codeplex-sac/navigation 0.0.5 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +265 -106
- package/index.mjs +3475 -3303
- package/lib/cajon-lateral/cajon-lateral.d.ts +53 -3
- package/lib/enlace/enlace.d.ts +26 -3
- package/lib/marcacion-rapida/marcacion-rapida.d.ts +40 -3
- package/lib/menu/menu.d.ts +49 -4
- package/lib/migas-pan/migas-pan.d.ts +48 -3
- package/lib/navegacion-inferior/navegacion-inferior.d.ts +56 -2
- package/lib/paginacion/paginacion.d.ts +24 -3
- package/lib/pasos/pasos.d.ts +67 -6
- package/lib/pestanas/pestanas.d.ts +65 -10
- package/package.json +4 -1
|
@@ -1,15 +1,65 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
2
|
import { DrawerProps, SwipeableDrawerProps } from '@mui/material';
|
|
3
|
-
export interface CodeplexCajonLateralProps extends Omit<DrawerProps, 'open' | 'onClose' | 'anchor' | 'PaperProps'> {
|
|
3
|
+
export interface CodeplexCajonLateralProps extends Omit<DrawerProps, 'open' | 'onClose' | 'anchor' | 'PaperProps' | 'children'> {
|
|
4
|
+
/**
|
|
5
|
+
* Si es verdadero, el cajón se puede abrir y cerrar mediante gestos táctiles (solo en móviles).
|
|
6
|
+
* Requiere que se definan `alAbrir` y `alCerrar`.
|
|
7
|
+
* @default false
|
|
8
|
+
*/
|
|
4
9
|
deslizable?: boolean;
|
|
10
|
+
/**
|
|
11
|
+
* Contenido que se mostrará dentro del cajón.
|
|
12
|
+
* Alias de `children`.
|
|
13
|
+
*/
|
|
14
|
+
hijos?: React.ReactNode;
|
|
15
|
+
/**
|
|
16
|
+
* Propiedad original de React para el contenido.
|
|
17
|
+
*/
|
|
18
|
+
children?: React.ReactNode;
|
|
19
|
+
/**
|
|
20
|
+
* Ancho fijo para el cajón cuando el anclaje es 'left' o 'right'.
|
|
21
|
+
* Puede ser un número (píxeles) o una cadena (ej. '50%').
|
|
22
|
+
* @default 280
|
|
23
|
+
*/
|
|
5
24
|
ancho?: number | string;
|
|
25
|
+
/**
|
|
26
|
+
* Contenido que aparecerá de forma fija en la parte superior del cajón.
|
|
27
|
+
*/
|
|
6
28
|
cabecera?: React.ReactNode;
|
|
29
|
+
/**
|
|
30
|
+
* Contenido que aparecerá de forma fija en la parte inferior del cajón.
|
|
31
|
+
*/
|
|
7
32
|
pie?: React.ReactNode;
|
|
33
|
+
/**
|
|
34
|
+
* Muestra un icono de cierre (X) en la cabecera.
|
|
35
|
+
* @default false
|
|
36
|
+
*/
|
|
8
37
|
mostrarIconoCierre?: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* Función que se ejecuta al intentar abrir el cajón mediante gestos (solo si `deslizable` es true).
|
|
40
|
+
*/
|
|
9
41
|
alAbrir?: SwipeableDrawerProps['onOpen'];
|
|
10
|
-
|
|
42
|
+
/**
|
|
43
|
+
* Función que se ejecuta al solicitar cerrar el cajón (clic fuera, ESC o icono de cierre).
|
|
44
|
+
*/
|
|
45
|
+
alCerrar?: (event: React.SyntheticEvent | {}, reason: 'backdropClick' | 'escapeKeyDown' | 'closeIcon') => void;
|
|
46
|
+
/**
|
|
47
|
+
* Controla si el cajón está visible.
|
|
48
|
+
* Alias de `open`.
|
|
49
|
+
*/
|
|
11
50
|
abierto?: boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Lado de la pantalla sobre el cual se anclará el cajón.
|
|
53
|
+
* @default 'left'
|
|
54
|
+
*/
|
|
12
55
|
anclaje?: DrawerProps['anchor'];
|
|
56
|
+
/**
|
|
57
|
+
* Props que se pasarán directamente al componente Paper interno.
|
|
58
|
+
*/
|
|
13
59
|
propsPapel?: DrawerProps['PaperProps'];
|
|
14
60
|
}
|
|
15
|
-
|
|
61
|
+
/**
|
|
62
|
+
* El componente CodeplexCajonLateral (Drawer) es un panel de navegación o contenido
|
|
63
|
+
* que se desliza desde los bordes de la pantalla.
|
|
64
|
+
*/
|
|
65
|
+
export declare const CodeplexCajonLateral: ({ deslizable, ancho, cabecera, pie, hijos, children, alAbrir, alCerrar, abierto, anclaje, mostrarIconoCierre, propsPapel, slotProps, sx, ...props }: CodeplexCajonLateralProps) => import("react/jsx-runtime").JSX.Element;
|
package/lib/enlace/enlace.d.ts
CHANGED
|
@@ -1,9 +1,32 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
1
2
|
import { LinkProps } from '@mui/material';
|
|
2
|
-
export interface CodeplexEnlaceProps extends Omit<LinkProps, 'underline'> {
|
|
3
|
+
export interface CodeplexEnlaceProps extends Omit<LinkProps, 'underline' | 'children'> {
|
|
3
4
|
/**
|
|
4
|
-
*
|
|
5
|
+
* El componente utilizado para el nodo raíz. Puede ser una cadena de etiqueta HTML o un componente de React.
|
|
6
|
+
* @default 'a'
|
|
5
7
|
*/
|
|
6
8
|
componente?: React.ElementType;
|
|
9
|
+
/**
|
|
10
|
+
* Controla cuándo se debe mostrar el subrayado.
|
|
11
|
+
* @default 'hover'
|
|
12
|
+
*/
|
|
7
13
|
subrayado?: 'none' | 'hover' | 'always';
|
|
14
|
+
/**
|
|
15
|
+
* Contenido del enlace.
|
|
16
|
+
* Alias de `children`.
|
|
17
|
+
*/
|
|
18
|
+
hijos?: React.ReactNode;
|
|
19
|
+
/**
|
|
20
|
+
* Propiedad original de React para el contenido.
|
|
21
|
+
*/
|
|
22
|
+
children?: React.ReactNode;
|
|
23
|
+
/**
|
|
24
|
+
* Función que se ejecuta al hacer clic en el enlace.
|
|
25
|
+
*/
|
|
26
|
+
alHacerClick?: (event: React.MouseEvent<HTMLAnchorElement | HTMLButtonElement>) => void;
|
|
8
27
|
}
|
|
9
|
-
|
|
28
|
+
/**
|
|
29
|
+
* El componente CodeplexEnlace permite crear vínculos de navegación con estilos consistentes
|
|
30
|
+
* y soporte para renderizado como otros componentes (ej. botones).
|
|
31
|
+
*/
|
|
32
|
+
export declare const CodeplexEnlace: ({ componente, subrayado, hijos, children, alHacerClick, onClick, ...props }: CodeplexEnlaceProps) => import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,13 +1,50 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
2
|
import { SpeedDialProps, SpeedDialActionProps } from '@mui/material';
|
|
3
|
-
|
|
3
|
+
/**
|
|
4
|
+
* Define una acción individual dentro del componente Marcación Rápida.
|
|
5
|
+
*/
|
|
6
|
+
export interface CodeplexAccionMarcacionRapida extends Omit<SpeedDialActionProps, 'icon' | 'tooltipTitle' | 'onClick'> {
|
|
7
|
+
/**
|
|
8
|
+
* El icono que se mostrará para esta acción.
|
|
9
|
+
*/
|
|
4
10
|
icono: React.ReactNode;
|
|
11
|
+
/**
|
|
12
|
+
* El texto que se mostrará en el tooltip al pasar el ratón por encima.
|
|
13
|
+
*/
|
|
5
14
|
tituloTooltip: React.ReactNode;
|
|
15
|
+
/**
|
|
16
|
+
* Función que se ejecuta al hacer clic en esta acción específica.
|
|
17
|
+
*/
|
|
6
18
|
alHacerClick?: SpeedDialActionProps['onClick'];
|
|
19
|
+
icon?: React.ReactNode;
|
|
20
|
+
tooltipTitle?: React.ReactNode;
|
|
21
|
+
onClick?: SpeedDialActionProps['onClick'];
|
|
7
22
|
}
|
|
8
|
-
export interface CodeplexMarcacionRapidaProps extends Omit<SpeedDialProps, 'ariaLabel' | 'icon'> {
|
|
23
|
+
export interface CodeplexMarcacionRapidaProps extends Omit<SpeedDialProps, 'ariaLabel' | 'icon' | 'children'> {
|
|
24
|
+
/**
|
|
25
|
+
* Lista de acciones que se desplegarán al interactuar con el botón principal.
|
|
26
|
+
*/
|
|
9
27
|
acciones?: CodeplexAccionMarcacionRapida[];
|
|
28
|
+
/**
|
|
29
|
+
* Etiqueta de accesibilidad (obligatoria para lectores de pantalla).
|
|
30
|
+
*/
|
|
10
31
|
etiquetaAria: string;
|
|
32
|
+
/**
|
|
33
|
+
* Icono principal que se muestra cuando el componente está cerrado.
|
|
34
|
+
*/
|
|
11
35
|
icono?: React.ReactNode;
|
|
36
|
+
/**
|
|
37
|
+
* Contenido personalizado si no se utilizan la prop `acciones`.
|
|
38
|
+
* Alias de `children`.
|
|
39
|
+
*/
|
|
40
|
+
hijos?: React.ReactNode;
|
|
41
|
+
/**
|
|
42
|
+
* Propiedad original de React para el contenido.
|
|
43
|
+
*/
|
|
44
|
+
children?: React.ReactNode;
|
|
12
45
|
}
|
|
13
|
-
|
|
46
|
+
/**
|
|
47
|
+
* El componente CodeplexMarcacionRapida (Speed Dial) muestra un botón flotante que,
|
|
48
|
+
* al interactuar con él, despliega una serie de acciones relacionadas.
|
|
49
|
+
*/
|
|
50
|
+
export declare const CodeplexMarcacionRapida: ({ acciones, icono, etiquetaAria, hijos, children, ...props }: CodeplexMarcacionRapidaProps) => import("react/jsx-runtime").JSX.Element;
|
package/lib/menu/menu.d.ts
CHANGED
|
@@ -1,14 +1,59 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
2
|
import { MenuProps, MenuItemProps } from '@mui/material';
|
|
3
|
+
/**
|
|
4
|
+
* Define una opción individual dentro del menú desplegable.
|
|
5
|
+
*/
|
|
3
6
|
export interface CodeplexElementoMenu extends Omit<MenuItemProps, 'children' | 'onClick'> {
|
|
4
|
-
|
|
7
|
+
/**
|
|
8
|
+
* El texto o contenido que se mostrará en la opción del menú.
|
|
9
|
+
*/
|
|
10
|
+
etiqueta?: React.ReactNode;
|
|
11
|
+
/**
|
|
12
|
+
* Icono opcional que se mostrará a la izquierda de la etiqueta.
|
|
13
|
+
*/
|
|
5
14
|
icono?: React.ReactNode;
|
|
6
|
-
|
|
15
|
+
/**
|
|
16
|
+
* Función que se ejecuta al hacer clic en esta opción específica.
|
|
17
|
+
*/
|
|
18
|
+
alHacerClick?: (event: React.MouseEvent<HTMLLIElement>) => void;
|
|
19
|
+
label?: React.ReactNode;
|
|
20
|
+
icon?: React.ReactNode;
|
|
21
|
+
onClick?: (event: React.MouseEvent<HTMLLIElement>) => void;
|
|
7
22
|
}
|
|
8
|
-
export interface CodeplexMenuProps extends Omit<MenuProps, 'open' | 'onClose' | 'anchorEl'> {
|
|
23
|
+
export interface CodeplexMenuProps extends Omit<MenuProps, 'open' | 'onClose' | 'anchorEl' | 'children'> {
|
|
24
|
+
/**
|
|
25
|
+
* Lista de elementos que se mostrarán en el menú de forma declarativa.
|
|
26
|
+
*/
|
|
9
27
|
elementos?: CodeplexElementoMenu[];
|
|
28
|
+
/**
|
|
29
|
+
* El elemento del DOM que se utilizará para posicionar el menú.
|
|
30
|
+
* Normalmente es una referencia a un botón o icono.
|
|
31
|
+
*/
|
|
10
32
|
elementoAnclaje?: MenuProps['anchorEl'];
|
|
33
|
+
/**
|
|
34
|
+
* Controla si el menú está visible.
|
|
35
|
+
* Alias de `open`.
|
|
36
|
+
*/
|
|
11
37
|
abierto: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* Función que se ejecuta al solicitar el cierre del menú (clic fuera o ESC).
|
|
40
|
+
*/
|
|
12
41
|
alCerrar?: MenuProps['onClose'];
|
|
42
|
+
/**
|
|
43
|
+
* Contenido personalizado si no se utilizan la prop `elementos`.
|
|
44
|
+
* Alias de `children`.
|
|
45
|
+
*/
|
|
46
|
+
hijos?: React.ReactNode;
|
|
47
|
+
/**
|
|
48
|
+
* Propiedad original de React para el contenido.
|
|
49
|
+
*/
|
|
50
|
+
children?: React.ReactNode;
|
|
51
|
+
open?: boolean;
|
|
52
|
+
onClose?: MenuProps['onClose'];
|
|
53
|
+
anchorEl?: MenuProps['anchorEl'];
|
|
13
54
|
}
|
|
14
|
-
|
|
55
|
+
/**
|
|
56
|
+
* El componente CodeplexMenu muestra una lista de opciones en una superficie temporal
|
|
57
|
+
* que aparece cuando el usuario interactúa con un botón u otro control.
|
|
58
|
+
*/
|
|
59
|
+
export declare const CodeplexMenu: ({ elementos, hijos, children, elementoAnclaje, anchorEl, abierto, open, alCerrar, onClose, ...props }: CodeplexMenuProps) => import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,14 +1,59 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
2
|
import { BreadcrumbsProps } from '@mui/material';
|
|
3
|
+
/**
|
|
4
|
+
* Define un elemento individual dentro de la cadena de navegación.
|
|
5
|
+
*/
|
|
3
6
|
export interface CodeplexElementoMigasPan {
|
|
4
|
-
|
|
7
|
+
/**
|
|
8
|
+
* El texto o contenido que se mostrará en la opción del menú.
|
|
9
|
+
*/
|
|
10
|
+
etiqueta?: React.ReactNode;
|
|
11
|
+
/**
|
|
12
|
+
* URL a la que redirigirá al hacer clic (opcional).
|
|
13
|
+
*/
|
|
5
14
|
href?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Icono opcional que se mostrará antes de la etiqueta.
|
|
17
|
+
*/
|
|
6
18
|
icono?: React.ReactElement;
|
|
19
|
+
label?: string;
|
|
20
|
+
icon?: React.ReactElement;
|
|
7
21
|
}
|
|
8
|
-
export interface CodeplexMigasPanProps extends Omit<BreadcrumbsProps, 'separator'> {
|
|
22
|
+
export interface CodeplexMigasPanProps extends Omit<BreadcrumbsProps, 'separator' | 'children'> {
|
|
23
|
+
/**
|
|
24
|
+
* Lista de elementos que componen la ruta de navegación.
|
|
25
|
+
*/
|
|
9
26
|
elementos: CodeplexElementoMigasPan[];
|
|
27
|
+
/**
|
|
28
|
+
* Si se proporciona, añade automáticamente un icono de "Inicio" al principio de la cadena.
|
|
29
|
+
*/
|
|
10
30
|
rutaInicio?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Color personalizado para el último elemento (el paso activo).
|
|
33
|
+
* @default 'text.primary'
|
|
34
|
+
*/
|
|
11
35
|
colorActivo?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Elemento o cadena que separa cada miga de pan.
|
|
38
|
+
* @default <NavigateNextIcon fontSize="small" />
|
|
39
|
+
*/
|
|
12
40
|
separador?: React.ReactNode;
|
|
41
|
+
/**
|
|
42
|
+
* Contenido personalizado si no se utilizan la prop `elementos`.
|
|
43
|
+
* Alias de `children`.
|
|
44
|
+
*/
|
|
45
|
+
hijos?: React.ReactNode;
|
|
46
|
+
/**
|
|
47
|
+
* Propiedad original de React para el contenido.
|
|
48
|
+
*/
|
|
49
|
+
children?: React.ReactNode;
|
|
50
|
+
items?: CodeplexElementoMigasPan[];
|
|
51
|
+
homeRoute?: string;
|
|
52
|
+
activeColor?: string;
|
|
53
|
+
separator?: React.ReactNode;
|
|
13
54
|
}
|
|
14
|
-
|
|
55
|
+
/**
|
|
56
|
+
* El componente CodeplexMigasPan (Breadcrumbs) ayuda a los usuarios a visualizar
|
|
57
|
+
* su ubicación actual dentro de una jerarquía de páginas.
|
|
58
|
+
*/
|
|
59
|
+
export declare const CodeplexMigasPan: ({ elementos, items, rutaInicio, homeRoute, colorActivo, activeColor, separador, separator, hijos, children, ...props }: CodeplexMigasPanProps) => import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,16 +1,70 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
1
2
|
import { BottomNavigationProps, SxProps, Theme } from '@mui/material';
|
|
3
|
+
/**
|
|
4
|
+
* Define un elemento individual dentro de la barra de navegación inferior.
|
|
5
|
+
*/
|
|
2
6
|
export interface CodeplexElementoNavegacionInferior {
|
|
7
|
+
/**
|
|
8
|
+
* El texto que se mostrará debajo del icono.
|
|
9
|
+
*/
|
|
3
10
|
etiqueta: string | React.ReactNode;
|
|
11
|
+
/**
|
|
12
|
+
* El icono que representará la acción.
|
|
13
|
+
*/
|
|
4
14
|
icono: React.ReactNode;
|
|
15
|
+
/**
|
|
16
|
+
* El valor asociado a este elemento (usado para controlar el estado activo).
|
|
17
|
+
*/
|
|
5
18
|
valor: any;
|
|
19
|
+
label?: string | React.ReactNode;
|
|
20
|
+
icon?: React.ReactNode;
|
|
21
|
+
value?: any;
|
|
6
22
|
[key: string]: any;
|
|
7
23
|
}
|
|
8
|
-
export interface CodeplexNavegacionInferiorProps extends Omit<BottomNavigationProps, 'onChange' | 'value'> {
|
|
24
|
+
export interface CodeplexNavegacionInferiorProps extends Omit<BottomNavigationProps, 'onChange' | 'value' | 'children'> {
|
|
25
|
+
/**
|
|
26
|
+
* Lista de elementos que componen la barra de navegación.
|
|
27
|
+
*/
|
|
9
28
|
elementos: CodeplexElementoNavegacionInferior[];
|
|
29
|
+
/**
|
|
30
|
+
* Si es verdadero, la barra se fijará en la parte inferior de la ventana (fixed).
|
|
31
|
+
* @default false
|
|
32
|
+
*/
|
|
10
33
|
fijo?: boolean;
|
|
34
|
+
/**
|
|
35
|
+
* Si es verdadero, envuelve la navegación en un componente Paper con elevación (patrón estándar móvil).
|
|
36
|
+
* @default true
|
|
37
|
+
*/
|
|
11
38
|
conPapel?: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Estilos adicionales para el contenedor Paper (si se usa).
|
|
41
|
+
*/
|
|
12
42
|
sxContenedor?: SxProps<Theme>;
|
|
43
|
+
/**
|
|
44
|
+
* Función que se ejecuta al cambiar de elemento seleccionado.
|
|
45
|
+
*/
|
|
13
46
|
alCambiar?: (event: React.SyntheticEvent, nuevoValor: any) => void;
|
|
47
|
+
/**
|
|
48
|
+
* El valor del elemento actualmente seleccionado.
|
|
49
|
+
*/
|
|
14
50
|
valor?: any;
|
|
51
|
+
/**
|
|
52
|
+
* Contenido personalizado si no se utilizan la prop `elementos`.
|
|
53
|
+
* Alias de `children`.
|
|
54
|
+
*/
|
|
55
|
+
hijos?: React.ReactNode;
|
|
56
|
+
/**
|
|
57
|
+
* Propiedad original de React para el contenido.
|
|
58
|
+
*/
|
|
59
|
+
children?: React.ReactNode;
|
|
60
|
+
items?: CodeplexElementoNavegacionInferior[];
|
|
61
|
+
fixed?: boolean;
|
|
62
|
+
withPaper?: boolean;
|
|
63
|
+
onChange?: (event: React.SyntheticEvent, nuevoValor: any) => void;
|
|
64
|
+
value?: any;
|
|
15
65
|
}
|
|
16
|
-
|
|
66
|
+
/**
|
|
67
|
+
* El componente CodeplexNavegacionInferior (Bottom Navigation) permite la navegación entre
|
|
68
|
+
* los destinos principales de una aplicación, especialmente optimizado para dispositivos móviles.
|
|
69
|
+
*/
|
|
70
|
+
export declare const CodeplexNavegacionInferior: ({ elementos, items, fijo, fixed, conPapel, withPaper, sxContenedor, sx, alCambiar, onChange, valor, value, hijos, children, ...props }: CodeplexNavegacionInferiorProps) => import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,11 +1,32 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
1
2
|
import { PaginationProps } from '@mui/material';
|
|
2
3
|
export interface CodeplexPaginacionProps extends Omit<PaginationProps, 'count' | 'page' | 'onChange'> {
|
|
4
|
+
/**
|
|
5
|
+
* El número total de páginas.
|
|
6
|
+
* Alias de `count`.
|
|
7
|
+
*/
|
|
3
8
|
total?: number;
|
|
9
|
+
/**
|
|
10
|
+
* El número de la página seleccionada actualmente.
|
|
11
|
+
* Alias de `page`.
|
|
12
|
+
*/
|
|
4
13
|
pagina?: number;
|
|
5
|
-
alCambiar?: PaginationProps['onChange'];
|
|
6
14
|
/**
|
|
7
|
-
*
|
|
15
|
+
* Función que se ejecuta al cambiar de página.
|
|
16
|
+
* Recibe el evento y el nuevo número de página.
|
|
17
|
+
*/
|
|
18
|
+
alCambiar?: (event: React.ChangeEvent<unknown>, page: number) => void;
|
|
19
|
+
/**
|
|
20
|
+
* Si es verdadero, centra la paginación horizontalmente dentro de su contenedor.
|
|
21
|
+
* @default false
|
|
8
22
|
*/
|
|
9
23
|
centrado?: boolean;
|
|
24
|
+
count?: number;
|
|
25
|
+
page?: number;
|
|
26
|
+
onChange?: (event: React.ChangeEvent<unknown>, page: number) => void;
|
|
10
27
|
}
|
|
11
|
-
|
|
28
|
+
/**
|
|
29
|
+
* El componente CodeplexPaginacion (Pagination) permite al usuario seleccionar una página
|
|
30
|
+
* específica de entre una serie de páginas.
|
|
31
|
+
*/
|
|
32
|
+
export declare const CodeplexPaginacion: ({ total, count, pagina, page, alCambiar, onChange, centrado, sx, ...props }: CodeplexPaginacionProps) => import("react/jsx-runtime").JSX.Element;
|
package/lib/pasos/pasos.d.ts
CHANGED
|
@@ -1,16 +1,77 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
1
2
|
import { StepperProps } from '@mui/material';
|
|
3
|
+
/**
|
|
4
|
+
* Define la configuración de un paso individual dentro del Stepper.
|
|
5
|
+
*/
|
|
2
6
|
export interface CodeplexPaso {
|
|
7
|
+
/**
|
|
8
|
+
* El título o etiqueta principal del paso.
|
|
9
|
+
*/
|
|
3
10
|
etiqueta: string;
|
|
4
|
-
|
|
11
|
+
/**
|
|
12
|
+
* Texto secundario que aparece debajo de la etiqueta (opcional).
|
|
13
|
+
*/
|
|
14
|
+
descripcion?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Si es verdadero, indica que el paso no es obligatorio.
|
|
17
|
+
*/
|
|
5
18
|
opcional?: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Si es verdadero, muestra el paso en estado de error (rojo).
|
|
21
|
+
*/
|
|
6
22
|
error?: boolean;
|
|
23
|
+
/**
|
|
24
|
+
* Si es verdadero, marca el paso como finalizado independientemente del flujo.
|
|
25
|
+
*/
|
|
7
26
|
completado?: boolean;
|
|
27
|
+
label?: string;
|
|
28
|
+
description?: string;
|
|
29
|
+
optional?: boolean;
|
|
30
|
+
completed?: boolean;
|
|
8
31
|
}
|
|
9
|
-
export interface CodeplexPasosProps extends Omit<StepperProps, 'activeStep' | '
|
|
10
|
-
|
|
32
|
+
export interface CodeplexPasosProps extends Omit<StepperProps, 'activeStep' | 'orientation' | 'children'> {
|
|
33
|
+
/**
|
|
34
|
+
* Lista de pasos que componen el flujo.
|
|
35
|
+
*/
|
|
36
|
+
pasos?: CodeplexPaso[];
|
|
37
|
+
/**
|
|
38
|
+
* El índice del paso que se encuentra activo actualmente (empezando en 0).
|
|
39
|
+
*/
|
|
11
40
|
pasoActivo: number;
|
|
12
|
-
|
|
41
|
+
/**
|
|
42
|
+
* La dirección del flujo: horizontal o vertical.
|
|
43
|
+
* @default 'horizontal'
|
|
44
|
+
*/
|
|
45
|
+
orientacion?: StepperProps['orientation'];
|
|
46
|
+
/**
|
|
47
|
+
* Si es verdadero, coloca las etiquetas debajo de los iconos en lugar de a la derecha.
|
|
48
|
+
*/
|
|
49
|
+
etiquetasAlternativas?: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Si es verdadero, permite hacer clic en las etiquetas para navegar directamente a un paso.
|
|
52
|
+
*/
|
|
13
53
|
noLineal?: boolean;
|
|
14
|
-
|
|
54
|
+
/**
|
|
55
|
+
* Función que se ejecuta al hacer clic en un paso (solo si `noLineal` es true).
|
|
56
|
+
*/
|
|
57
|
+
alHacerClickEnPaso?: (indice: number) => void;
|
|
58
|
+
/**
|
|
59
|
+
* Contenido personalizado si no se utilizan la prop `pasos`.
|
|
60
|
+
* Alias de `children`.
|
|
61
|
+
*/
|
|
62
|
+
hijos?: React.ReactNode;
|
|
63
|
+
/**
|
|
64
|
+
* Propiedad original de React para el contenido.
|
|
65
|
+
*/
|
|
66
|
+
children?: React.ReactNode;
|
|
67
|
+
activeStep?: number;
|
|
68
|
+
orientation?: StepperProps['orientation'];
|
|
69
|
+
alternativeLabel?: boolean;
|
|
70
|
+
nonLinear?: boolean;
|
|
71
|
+
onStepClick?: (index: number) => void;
|
|
15
72
|
}
|
|
16
|
-
|
|
73
|
+
/**
|
|
74
|
+
* El componente CodeplexPasos (Stepper) guía al usuario a través de un proceso
|
|
75
|
+
* de varios pasos secuenciales o no secuenciales.
|
|
76
|
+
*/
|
|
77
|
+
export declare const CodeplexPasos: ({ pasos, pasoActivo, activeStep, orientacion, orientation, etiquetasAlternativas, alternativeLabel, noLineal, nonLinear, alHacerClickEnPaso, onStepClick, hijos, children, ...props }: CodeplexPasosProps) => import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,15 +1,70 @@
|
|
|
1
1
|
import { default as React } from 'react';
|
|
2
|
-
import { TabsProps
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
import { TabsProps } from '@mui/material';
|
|
3
|
+
/**
|
|
4
|
+
* Define una pestaña individual dentro del componente Pestañas.
|
|
5
|
+
*/
|
|
6
|
+
export interface CodeplexElementoPestana {
|
|
7
|
+
/**
|
|
8
|
+
* El texto que se mostrará en la pestaña.
|
|
9
|
+
*/
|
|
10
|
+
etiqueta: string;
|
|
11
|
+
/**
|
|
12
|
+
* Icono opcional que se mostrará junto a la etiqueta.
|
|
13
|
+
*/
|
|
6
14
|
icono?: React.ReactElement;
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
elementos: CodeplexElementoPestana[];
|
|
15
|
+
/**
|
|
16
|
+
* El valor asociado a esta pestaña (usado para controlar el estado activo).
|
|
17
|
+
*/
|
|
11
18
|
valor: any;
|
|
12
|
-
|
|
19
|
+
/**
|
|
20
|
+
* Si es verdadero, la pestaña no podrá ser seleccionada.
|
|
21
|
+
*/
|
|
22
|
+
deshabilitado?: boolean;
|
|
23
|
+
label?: string;
|
|
24
|
+
icon?: React.ReactElement;
|
|
25
|
+
value?: any;
|
|
26
|
+
disabled?: boolean;
|
|
27
|
+
}
|
|
28
|
+
export interface CodeplexPestanasProps extends Omit<TabsProps, 'value' | 'onChange' | 'children'> {
|
|
29
|
+
/**
|
|
30
|
+
* Lista de pestañas que se mostrarán.
|
|
31
|
+
*/
|
|
32
|
+
elementos?: CodeplexElementoPestana[];
|
|
33
|
+
/**
|
|
34
|
+
* El valor de la pestaña actualmente seleccionada.
|
|
35
|
+
*/
|
|
36
|
+
valor?: any;
|
|
37
|
+
/**
|
|
38
|
+
* Función que se ejecuta al cambiar la pestaña seleccionada.
|
|
39
|
+
*/
|
|
40
|
+
alCambiar?: (event: React.SyntheticEvent, nuevoValor: any) => void;
|
|
41
|
+
/**
|
|
42
|
+
* Si es verdadero, las pestañas se centrarán horizontalmente.
|
|
43
|
+
* @default false
|
|
44
|
+
*/
|
|
13
45
|
centrado?: boolean;
|
|
46
|
+
/**
|
|
47
|
+
* La posición del icono respecto a la etiqueta de la pestaña.
|
|
48
|
+
* @default 'top'
|
|
49
|
+
*/
|
|
50
|
+
posicionIcono?: 'top' | 'bottom' | 'start' | 'end';
|
|
51
|
+
/**
|
|
52
|
+
* Contenido personalizado si no se utilizan la prop `elementos`.
|
|
53
|
+
* Alias de `children`.
|
|
54
|
+
*/
|
|
55
|
+
hijos?: React.ReactNode;
|
|
56
|
+
/**
|
|
57
|
+
* Propiedad original de React para el contenido.
|
|
58
|
+
*/
|
|
59
|
+
children?: React.ReactNode;
|
|
60
|
+
items?: CodeplexElementoPestana[];
|
|
61
|
+
value?: any;
|
|
62
|
+
onChange?: (event: React.SyntheticEvent, nuevoValor: any) => void;
|
|
63
|
+
centered?: boolean;
|
|
64
|
+
iconPosition?: 'top' | 'bottom' | 'start' | 'end';
|
|
14
65
|
}
|
|
15
|
-
|
|
66
|
+
/**
|
|
67
|
+
* El componente CodeplexPestanas (Tabs) permite organizar contenido en diferentes vistas
|
|
68
|
+
* entre las que se puede navegar de forma rápida.
|
|
69
|
+
*/
|
|
70
|
+
export declare const CodeplexPestanas: ({ elementos, items, valor, value, alCambiar, onChange, centrado, centered, posicionIcono, iconPosition, hijos, children, sx, ...props }: CodeplexPestanasProps) => import("react/jsx-runtime").JSX.Element;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@codeplex-sac/navigation",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.6",
|
|
4
4
|
"main": "./index.js",
|
|
5
5
|
"types": "./index.d.ts",
|
|
6
6
|
"exports": {
|
|
@@ -10,6 +10,9 @@
|
|
|
10
10
|
"require": "./index.js"
|
|
11
11
|
}
|
|
12
12
|
},
|
|
13
|
+
"publishConfig": {
|
|
14
|
+
"access": "public"
|
|
15
|
+
},
|
|
13
16
|
"peerDependencies": {
|
|
14
17
|
"react": "^19.0.0",
|
|
15
18
|
"react-dom": "^19.0.0"
|