Skip to content

Commit

Permalink
v0.3.15
Browse files Browse the repository at this point in the history
  • Loading branch information
CarcajadaArtificial committed Mar 6, 2024
1 parent c938721 commit 00a61ad
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## v0.3.14
## v0.3.15

- Updated the `<Button />` component's documentation.

Expand Down
2 changes: 1 addition & 1 deletion components/Button/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import setup, { iButton } from './setup.ts';

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/**
* Render function for the [`<Button/ >`](/components/Button) component.
* Render function for the [`<Button/ >`](/x/lunchbox/components/Button/setup.ts?s=iButton) component.
*
* @param {Partial<iButton>} props
* {@link iButton} (Partial by [design](https://deno.land/x/lunchbox#configure-anything-easily))
Expand Down
12 changes: 8 additions & 4 deletions components/Button/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,17 @@ import { css } from '../../deps.ts';
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/**
* Properties of the `<Button />` component.
* - `maxWidth` (boolean):
*
* `maxWidth` (boolean):
* If true, expands the width of the button up to its maximum width.
* - `compact` (boolean):
*
* `compact` (boolean):
* If true, the button's paddings will be shorter.
* - `large` (boolean):
*
* `large` (boolean):
* If true, the button's paddings will be larger.
* - `type` (ButtonTypes):
*
* `type` (ButtonTypes):
* Changes the button's style depending on the property.
* - **disabled:** Adds `cursor: not-allowed` and makes it look unavailable.
* - **error:** Makes it the standard red color.
Expand Down
13 changes: 8 additions & 5 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,14 @@ import { JSX, Ref } from 'preact';
* HTMLElement that inherits its attributes, the GenericComponent properties, Aria atributes, and Event
* Handlers. [See more](https://deno.land/x/lunchbox#configure-anything-easily)
*
* - `fref?` (Ref<T>):
* `fref?` (Ref<T>):
* Short for "Forwarded Reference". This prop allows the component to receive a preact reference
* that points to the protagonist HTMLElement in the component.
* - `nostyle?` (boolean):
*
* `nostyle?` (boolean):
* This prop removes the default styles of the component.
* - `nostyleAll?` (boolean):
*
* `nostyleAll?` (boolean):
* This prop removes the default styles and the class names of all HTMLElements in the component.
*/
export type iComponent<T extends EventTarget = HTMLElement> =
Expand All @@ -45,9 +47,10 @@ export type iElement<T extends EventTarget = HTMLElement> =
* This type is a shorthand that helps in forwarding props and references to a component's part. This
* type points to every secondary HTMLElement in a component.
*
* - `ref?` (Ref<T>):
* `ref?` (Ref<T>):
* Stores a reference that points to this HTMLElement.
* - `nostyle?` (boolean):
*
* `nostyle?` (boolean):
* If true, removes the default class name of this HTMLElement.
*/
export type iFwd<T extends EventTarget = HTMLElement> = iElement<T> & {
Expand Down

0 comments on commit 00a61ad

Please sign in to comment.