v0.3.13

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## v0.3.12
+## v0.3.13
 
 - Updated the `<Button />` component's documentation.
 

components/Button/index.tsx

@@ -16,7 +16,7 @@ import setup, { iButton } from './setup.ts';
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 /**
- * Render function for the [`<Button/>`]{@link components/Button} component.
+ * Render function for the [`<Button/ >`](/components/Button) component.
  *
  * @param {Partial<iButton>} props
  *  {@link iButton} (Partial by [design](https://deno.land/x/lunchbox#configure-anything-easily))

components/Button/setup.ts

@@ -16,8 +16,8 @@ import { transition } from '../../src/styles.ts';
 import { css } from '../../deps.ts';
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** Property type of the `<Button />` component. */
-export type iButton = iComponent<HTMLButtonElement> & {
+/** Properties of the `<Button />` component. */
+export type ButtonProps = {
   /** If true, expands the width of the button up to its maximum width. */
   maxWidth: boolean;
   /** If true, the button's paddings will be shorter. */
@@ -35,8 +35,10 @@ export type iButton = iComponent<HTMLButtonElement> & {
   type: ButtonTypes;
 };
 
-// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-/** These are the default values of the `<Button />` component's props. */
+/** Property type of the `<Button />` component. */
+export type iButton = iComponent<HTMLButtonElement> & ButtonProps;
+
+/** Default values of the `<Button />` component's props. */
 const defaults: iButton = {
   maxWidth: false,
   compact: false,

src/types.ts

@@ -1,29 +1,50 @@
-//   ___ _                   _
-//  | __| |___ _ __  ___ _ _| |_
-//  | _|| / -_) '  \/ -_) ' \  _|
-//  |___|_\___|_|_|_\___|_||_\__|
-//
+//   _____
+//  |_   _|  _ _ __  ___ ___
+//    | || || | '_ \/ -_|_-<
+//    |_| \_, | .__/\___/__/
+//        |__/|_|
 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 /**
- * This module contains auxiliary types related to HTML Elements and their properties.
+ * This module contains auxiliary types.
+ *
  * @module
  */
-
 import { JSX, Ref } from 'preact';
 
-export type iComponent<T extends EventTarget = HTMLElement> = iElement<T> & {
+/**
+ * This is a utility type that contains properties that all components must have.
+ * [See more](https://deno.land/x/lunchbox#configure-anything-easily)
+ */
+export type GenericComponent<T> = {
+  /**
+   * Short for "Forwarded Reference". This prop allows the component to receive a preact reference
+   * that points to the protagonist HTMLElement in the component.
+   */
   fref?: Ref<T>;
+  /** This prop removes the default styles for the component. */
   nostyle?: boolean;
+  /** This prop removes the default styles and all class names for the component. */
   nostyleAll?: boolean;
 };
 
 /**
- * This type is a shorthand for an extension of `JSX.HTMLAttributes<T>`, `Partial<ARIAMixin>`, and ` Partial<GlobalEventHandlers>`.
+ * This type is used for standarizing all components. By design every component must have a protagonic
+ * HTMLElement that inherits its attributes, the GenericComponent properties, Aria atributes, and Event
+ * Handlers.
+ */
+export type iComponent<T extends EventTarget = HTMLElement> =
+  & iElement<T>
+  & GenericComponent<T>;
+
+/**
+ * This type is a shorthand for an extension of `JSX.HTMLAttributes<T>`, `Partial<ARIAMixin>`, and
+ * `Partial<GlobalEventHandlers>`.
  */
 export type iElement<T extends EventTarget = HTMLElement> =
   & JSX.HTMLAttributes<T>
   & Partial<ARIAMixin>
   & Partial<GlobalEventHandlers>;
+
 /**
  *  This type is a shorthand that helps in forwarding props and references to a component's part.
  */
@@ -33,6 +54,7 @@ export type iFwd<T extends EventTarget = HTMLElement> = iElement<T> & {
 };
 
 /**
- * This type is a shorthand of `Record<string | number | symbol, never>` that `deno-lint(ban-types) recommends as the correct way to express the type of an empty object.`.
+ * This type is a shorthand of `Record<string | number | symbol, never>` that
+ * `deno-lint(ban-types) recommends as the correct way to express the type of an empty object.`.
  */
 export type EmptyObject = Record<string | number | symbol, never>;