chore: rm verbose descriptions

packages/ui-buttons/src/ButtonHelp/types.ts

@@ -4,24 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps } from '../types';
 
-/**
- * @name {Object} ButtonPrimaryProps
- * @description Props for the ButtonPrimary component.
- * @property {boolean} [disabled=false] - If true, the button is disabled and cannot be
- * clicked.
- * @property {boolean} [marginLeft=false] - If true, applies a left margin to the button.
- * @property {boolean} [marginRight=false] - If true, applies a right margin to the button.
- * @property {boolean} [marginX=false] - If true, applies horizontal margins to the button.
- * @property {string} [className] - Additional custom class names to apply to the button.
- * @property {React.CSSProperties} [style] - Inline styles for custom styling of the button.
- * @property {() => void} [onClick] - Callback function to handle button click events.
- * @property {() => void} [onMouseOver] - Callback function to handle mouse over events.
- * @property {() => void} [onMouseMove] - Callback function to handle mouse move events.
- * @property {() => void} [onMouseOut] - Callback function to handle mouse out events.
- * @property {boolean} [outline=false] - If true, applies an outline style to the button.
- * @property {'primary' | 'secondary' | 'none'} [background='primary'] - Sets the background
- * style of the button; can be 'primary', 'secondary', or 'none'.
- */
 export type ButtonHelpProps = ComponentBaseWithClassName &
   ButtonCommonProps & {
     background?: 'primary' | 'secondary' | 'none';

packages/ui-buttons/src/ButtonMono/types.ts

@@ -4,33 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps, ButtonIconProps } from '../types';
 
-/**
- * @name {Object} ButtonMonoProps
- * @description Props for the ButtonMono component.
- * @property {boolean} [disabled=false] - If true, the button is disabled and cannot be interacted
- * with.
- * @property {boolean} [grow=false] - If true, the button will expand to fill available space.
- * @property {string | undefined} [iconLeft] - Optional FontAwesome icon to display on the left side
- * of the button text.
- * @property {string | undefined} [iconRight] - Optional FontAwesome icon to display on the right
- * side of the button text.
- * @property {string | undefined} [iconTransform] - Optional transformation rules for the
- * FontAwesome icons.
- * @property {boolean} [lg=false] - If true, the button is rendered as a large button; otherwise, it
- * defaults to a small button.
- * @property {boolean} [marginLeft=false] - If true, applies left margin spacing to the button.
- * @property {boolean} [marginRight=false] - If true, applies right margin spacing to the button.
- * @property {boolean} [marginX=false] - If true, applies horizontal margin spacing to the button.
- * @property {string | undefined} [className] - Additional custom class names to apply to the button
- * for further styling.
- * @property {React.CSSProperties | undefined} [style] - Inline styles for applying custom styles
- * directly.
- * @property {string} [text] - Text content to be displayed within the button.
- * @property {() => void} [onClick] - Callback function to handle button click events.
- * @property {() => void} [onMouseOver] - Callback function to handle mouse over events.
- * @property {() => void} [onMouseMove] - Callback function to handle mouse move events.
- * @property {() => void} [onMouseOut] - Callback function to handle mouse out events.
- */
 export type ButtonMonoProps = ComponentBaseWithClassName &
   ButtonIconProps &
   ButtonCommonProps & {

packages/ui-buttons/src/ButtonMonoInvert/types.ts

@@ -4,33 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps, ButtonIconProps } from '../types';
 
-/**
- * @name {Object} ButtonMonoInvertProps
- * @description Props for the ButtonMonoInvert component.
- * @property {boolean} [disabled=false] - If true, the button is disabled and cannot be interacted
- * with.
- * @property {boolean} [grow=false] - If true, the button will expand to fill available space.
- * @property {string | undefined} [iconLeft] - Optional FontAwesome icon to display on the left side
- * of the button text.
- * @property {string | undefined} [iconRight] - Optional FontAwesome icon to display on the right
- * side of the button text.
- * @property {string | undefined} [iconTransform] - Optional transformation rules for the
- * FontAwesome icons.
- * @property {boolean} [lg=false] - If true, the button is rendered as a large button; otherwise, it
- * defaults to a small button.
- * @property {boolean} [marginLeft=false] - If true, applies left margin spacing to the button.
- * @property {boolean} [marginRight=false] - If true, applies right margin spacing to the button.
- * @property {boolean} [marginX=false] - If true, applies horizontal margin spacing to the button.
- * @property {string | undefined} [className] - Additional custom class names to apply to the button
- * for further styling.
- * @property {React.CSSProperties | undefined} [style] - Inline styles for applying custom styles
- * directly.
- * @property {string} [text] - Text content to be displayed within the button.
- * @property {() => void} [onClick] - Callback function to handle button click events.
- * @property {() => void} [onMouseOver] - Callback function to handle mouse over events.
- * @property {() => void} [onMouseMove] - Callback function to handle mouse move events.
- * @property {() => void} [onMouseOut] - Callback function to handle mouse out events.
- */
 export type ButtonMonoInvertProps = ComponentBaseWithClassName &
   ButtonIconProps &
   ButtonCommonProps & {

packages/ui-buttons/src/ButtonOption/types.ts

@@ -4,24 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps } from '../types';
 
-/**
- * @name {Object} ButtonOptionProps
- * @description Props for the ButtonOption component.
- * @property {React.ReactNode} [children] - Optional child elements to render inside the button,
- * typically additional content or nested components.
- * @property {string | undefined} [className] - Additional custom class names to apply to the button
- * for further styling.
- * @property {React.CSSProperties | undefined} [style] - Inline styles for applying custom styles
- * directly.
- * @property {boolean} [disabled=false] - If true, the button is disabled and cannot be interacted
- * with.
- * @property {string | undefined} [content] - Optional content used to modify the button's behavior or
- * style when present.
- * @property {() => void} [onClick] - Callback function to handle button click events.
- * @property {() => void} [onMouseOver] - Callback function to handle mouse over events.
- * @property {() => void} [onMouseMove] - Callback function to handle mouse move events.
- * @property {() => void} [onMouseOut] - Callback function to handle mouse out events.
- */
 export type ButtonOptionProps = ComponentBaseWithClassName &
   ButtonCommonProps & {
     content?: boolean;

packages/ui-buttons/src/ButtonPrimary/types.ts

@@ -4,37 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps, ButtonIconProps } from '../types';
 
-/**
- * @name {Object} ButtonPrimaryProps
- * @description Props for the ButtonPrimary component.
- * @property {string | undefined} [className] - Additional custom class name(s) to apply to the
- * button.
- * @property {boolean} [colorSecondary=false] - If true, use the secondary network color for the
- * button.
- * @property {boolean} [disabled=false] - If true, the button is disabled.
- * @property {boolean} [grow=false] - If true, the button will have a grow effect (e.g., for
- * flex-based layouts).
- * @property {string | undefined} [iconLeft] - An optional FontAwesome icon to display on the left
- * side of the button text.
- * @property {string | undefined} [iconRight] - An optional FontAwesome icon to display on the right
- * side of the button text.
- * @property {string | undefined} [iconTransform] - Optional transformation rules for the
- * FontAwesome icons (e.g., size or rotation).
- * @property {boolean} [lg=false] - If true, renders the button as a large button; otherwise, it
- * defaults to a small button.
- * @property {boolean} [marginLeft=false] - If true, applies a left margin utility class to the
- * button.
- * @property {boolean} [marginRight=false] - If true, applies a right margin utility class to the
- * button.
- * @property {boolean} [marginX=false] - If true, applies horizontal margin utility classes to the
- * button.
- * @property {() => void} [onClick] - Callback function to handle button click events.
- * @property {() => void} [onMouseMove] - Callback function to handle mouse move events.
- * @property {() => void} [onMouseOut] - Callback function to handle mouse out events.
- * @property {() => void} [onMouseOver] - Callback function to handle mouse over events.
- * @property {React.CSSProperties | undefined} [style] - Inline styles to apply to the button.
- * @property {string} text - The text label to display within the button.
- */
 export type ButtonPrimaryProps = ComponentBaseWithClassName &
   ButtonIconProps &
   ButtonCommonProps & {

packages/ui-buttons/src/ButtonPrimaryInvert/types.ts

@@ -4,37 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps, ButtonIconProps } from '../types';
 
-/**
- * @name {Object} ButtonPrimaryInvertProps
- * @description Props for the ButtonPrimaryInvert component.
- * @property {string | undefined} [className] - Additional custom class name(s) to apply to the
- * button.
- * @property {boolean} [colorSecondary=false] - If true, use the secondary network color for the
- * button.
- * @property {boolean} [disabled=false] - If true, the button is disabled.
- * @property {boolean} [grow=false] - If true, the button will have a grow effect (e.g., for
- * flex-based layouts).
- * @property {string | undefined} [iconLeft] - An optional FontAwesome icon to display on the left
- * side of the button text.
- * @property {string | undefined} [iconRight] - An optional FontAwesome icon to display on the right
- * side of the button text.
- * @property {string | undefined} [iconTransform] - Optional transformation rules for the
- * FontAwesome icons (e.g., size or rotation).
- * @property {boolean} [lg=false] - If true, renders the button as a large button; otherwise, it
- * defaults to a small button.
- * @property {boolean} [marginLeft=false] - If true, applies a left margin utility class to the
- * button.
- * @property {boolean} [marginRight=false] - If true, applies a right margin utility class to the
- * button.
- * @property {boolean} [marginX=false] - If true, applies horizontal margin utility classes to the
- * button.
- * @property {() => void} [onClick] - Callback function to handle button click events.
- * @property {() => void} [onMouseMove] - Callback function to handle mouse move events.
- * @property {() => void} [onMouseOut] - Callback function to handle mouse out events.
- * @property {() => void} [onMouseOver] - Callback function to handle mouse over events.
- * @property {React.CSSProperties | undefined} [style] - Inline styles to apply to the button.
- * @property {string} text - The text label to display within the button.
- */
 export type ButtonPrimaryInvertProps = ComponentBaseWithClassName &
   ButtonIconProps &
   ButtonCommonProps & {

packages/ui-buttons/src/ButtonSecondary/types.ts

@@ -4,37 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps, ButtonIconProps } from '../types';
 
-/**
- * @name {Object} ButtonSecondaryProps
- * @description Props for the ButtonSecondary component.
- * @property {string | undefined} [className] - Additional custom class name(s) to apply to the
- * button.
- * @property {boolean} [colorSecondary=false] - If true, use the secondary network color for the
- * button.
- * @property {boolean} [disabled=false] - If true, the button is disabled.
- * @property {boolean} [grow=false] - If true, the button will have a grow effect (e.g., for
- * flex-based layouts).
- * @property {string | undefined} [iconLeft] - An optional FontAwesome icon to display on the left
- * side of the button text.
- * @property {string | undefined} [iconRight] - An optional FontAwesome icon to display on the right
- * side of the button text.
- * @property {string | undefined} [iconTransform] - Optional transformation rules for the
- * FontAwesome icons (e.g., size or rotation).
- * @property {boolean} [lg=false] - If true, renders the button as a large button; otherwise, it
- * defaults to a small button.
- * @property {boolean} [marginLeft=false] - If true, applies a left margin utility class to the
- * button.
- * @property {boolean} [marginRight=false] - If true, applies a right margin utility class to the
- * button.
- * @property {boolean} [marginX=false] - If true, applies horizontal margin utility classes to the
- * button.
- * @property {() => void} [onClick] - Callback function to handle button click events.
- * @property {() => void} [onMouseMove] - Callback function to handle mouse move events.
- * @property {() => void} [onMouseOut] - Callback function to handle mouse out events.
- * @property {() => void} [onMouseOver] - Callback function to handle mouse over events.
- * @property {React.CSSProperties | undefined} [style] - Inline styles to apply to the button.
- * @property {string} text - The text label to display within the button.
- */
 export type ButtonSecondaryProps = ComponentBaseWithClassName &
   ButtonIconProps &
   ButtonCommonProps & {

packages/ui-buttons/src/ButtonSubmit/types.ts

@@ -4,37 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps, ButtonIconProps } from '../types';
 
-/**
- * @name {Object} ButtonSubmitProps
- * @description Props for the ButtonSubmit component.
- * @property {boolean} [colorSecondary=false] - If true, applies a secondary color style to the
- * button.
- * @property {boolean} [disabled=false] - If true, the button is disabled and cannot be interacted
- * with.
- * @property {boolean} [grow=false] - If true, makes the button grow to fill available space.
- * @property {string | undefined} [iconLeft] - Optional FontAwesome icon to display on the left side
- * of the button text.
- * @property {string | undefined} [iconRight] - Optional FontAwesome icon to display on the right
- * side of the button text.
- * @property {string | undefined} [iconTransform] - Optional transformation rules for the
- * FontAwesome icons.
- * @property {boolean} [marginLeft=false] - If true, applies left margin spacing to the button.
- * @property {boolean} [marginRight=false] - If true, applies right margin spacing to the button.
- * @property {boolean} [marginX=false] - If true, applies horizontal margin spacing to the button.
- * @property {string | undefined} [className] - Additional custom class names to apply to the button
- * for further styling.
- * @property {React.CSSProperties | undefined} [style] - Inline styles for applying custom styles
- * directly.
- * @property {string} [text] - The text to be displayed within the button.
- * @property {boolean} [lg=false] - If true, renders the button as a large button; otherwise, it
- * defaults to a smaller size.
- * @property {boolean} [pulse=false] - If true, applies a pulse animation style to the button for
- * emphasis.
- * @property {() => void} [onClick] - Callback function to handle button click events.
- * @property {() => void} [onMouseOver] - Callback function to handle mouse over events.
- * @property {() => void} [onMouseMove] - Callback function to handle mouse move events.
- * @property {() => void} [onMouseOut] - Callback function to handle mouse out events.
- */
 export type ButtonSubmitProps = ComponentBaseWithClassName &
   ButtonIconProps &
   ButtonCommonProps & {

packages/ui-buttons/src/ButtonSubmitInvert/types.ts

@@ -4,38 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps, ButtonIconProps } from '../types';
 
-/**
- * @name {Object} ButtonSubmitInvertProps
- * @description Props for the ButtonSubmitInvert component.
- *
- *component.
- * @property {boolean} [disabled=false] - If true, the button is disabled, preventing user
- *interaction.
- * @property {boolean} [grow=false] - If true, allows the button to expand to fill available space.
- * @property {string | undefined} [iconLeft] - Optional FontAwesome icon displayed on the left side
- * of the button text.
- * @property {string | undefined} [iconRight] - Optional FontAwesome icon displayed on the right
- * side of the button text.
- * @property {string | undefined} [iconTransform] - Optional transformation rules for the
- * FontAwesome icons (e.g., size or rotation).
- * @property {boolean} [marginLeft=false] - If true, applies left margin spacing to the button.
- * @property {boolean} [marginRight=false] - If true, applies right margin spacing to the button.
- * @property {boolean} [marginX=false] - If true, applies horizontal margin spacing to the button.
- * @property {string | undefined} [className] - Additional custom class names to apply to the button
- * for extended styling options.
- * @property {React.CSSProperties | undefined} [style] - Inline styles for applying custom styles
- * directly to the button.
- * @property {string} [text] - Text content displayed within the button.
- * @property {boolean} [lg=false] - If true, renders the button as a large button; otherwise, it
- * defaults to a smaller size.
- * @property {() => void} [onClick] - Callback function triggered on button click events.
- * @property {() => void} [onMouseOver] - Callback function triggered on mouse over events.
- * @property {() => void} [onMouseMove] - Callback function triggered on mouse move events.
- * @property {() => void} [onMouseOut] - Callback function triggered on mouse out events.
- *
- * @returns {JSX.Element} The rendered ButtonSubmitInvert component, styled and configured based on
- * the provided  with optional icon and text content.
- */
 export type ButtonSubmitInvertProps = ComponentBaseWithClassName &
   ButtonIconProps &
   ButtonCommonProps & {

packages/ui-buttons/src/ButtonTab/types.ts

@@ -4,32 +4,6 @@
 import type { ComponentBaseWithClassName } from '@w3ux/types';
 import type { ButtonCommonProps } from '../types';
 
-/**
- * @naem {Object} ButtonTabProps
- * @description A tab-style button component used to represent selectable tabs within an interface.
- * This component supports active states, badges for additional information, and customizable styles
- * and event handling, making it suitable for interactive tab navigation or selection.
- *
- * @property {boolean} [disabled=false] - If true, the button is disabled and cannot be interacted
- * with.
- * @property {boolean} [colorSecondary=false] - If true, use the secondary network color for the
- * button.
- * @property {string | undefined} [className] - Additional custom class names to apply to the button
- * for extended styling options.
- * @property {React.CSSProperties | undefined} [style] - Inline styles for applying custom styles
- * directly to the button.
- * @property {boolean} [active=false] - If true, applies an active state style to the button.
- * @property {string} [title] - The text content to be displayed within the button.
- * @property {string | number | undefined} [badge] - Optional badge content to display alongside the
- * title.
- * @property {() => void} [onClick] - Callback function to handle button click events.
- * @property {() => void} [onMouseOver] - Callback function to handle mouse over events.
- * @property {() => void} [onMouseMove] - Callback function to handle mouse move events.
- * @property {() => void} [onMouseOut] - Callback function to handle mouse out events.
- *
- * @returns {JSX.Element} The rendered ButtonTab component, styled and configured based on the
- * provided  with support for optional title and badge content.
- */
 export type ButtonTabProps = ComponentBaseWithClassName &
   ButtonCommonProps & {
     colorSecondary?: boolean;