# @types/hig__button

> TypeScript definitions for @hig/button

Latest version **1.4.7** (published 2023-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/hig__button
pnpm add @types/hig__button
yarn add @types/hig__button
bun add @types/hig__button
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.4.7 |
| Published | 2023-12-06 |
| First published | 2019-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51437 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/hig__button
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hig__button
- npm.io page: https://npm.io/package/@types/hig__button

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 1.4.7 (latest) — 2023-12-06
- 1.4.6 (ts4.5) — 2023-11-07
- 1.4.3 (ts3.6) — 2021-07-08
- 1.4.2 (ts3.2) — 2020-09-26
- 1.4.1 (ts3.1) — 2020-08-31
- 1.4.0 (ts3.0) — 2019-10-15
- 1.4.5 — 2023-10-18
- 1.4.4 — 2023-09-16

## README

# Installation
> `npm install --save @types/hig__button`

# Summary
This package contains type definitions for @hig/button (https://github.com/Autodesk/hig/tree/development/packages/button).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hig__button.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hig__button/index.d.ts)
````ts
// Turn off automatic exporting
export {};

import * as React from "react";

type Callback = () => void;

export interface Targets {
    SELF: "_self";
    BLANK: "_blank";
    PARENT: "_parent";
    TOP: "_top";
}
export interface Types {
    FLAT: "flat";
    OUTLINE: "outline";
    SOLID: "solid";
    /** @deprecated */
    PRIMARY: "primary";
    /** @deprecated */
    SECONDARY: "secondary";
}
export interface Widths {
    SHRINK: "shrink";
    GROW: "grow";
}
export type AvailableTargets = Targets[keyof Targets];
export type AvailableTypes = Types[keyof Types];
export type AvailableWidths = Widths[keyof Widths];

export interface Props {
    /** Prevents user interaction with the button */
    disabled?: boolean | undefined;
    /** A @hig/icon element */
    icon?: React.JSX.Element | undefined;
    /** Sets the link of a button */
    link?: string | undefined;
    /** Triggers when you click the button */
    onClick?: Callback | undefined;
    /** Triggers blur when focus is moved away from icon */
    onBlur?: Callback | undefined;
    /** Triggers when focus is moved to button */
    onFocus?: Callback | undefined;
    /** Triggers when you hover over the button */
    onHover?: Callback | undefined;
    /** Triggers when the user's mouse is pressed over the button */
    onMouseDown?: Callback | undefined;
    /** Triggers when the user's mouse is over the button */
    onMouseEnter?: Callback | undefined;
    /** Triggers when the user's mouse is no longer over the button */
    onMouseLeave?: Callback | undefined;
    /** Triggers when the user's mouse is no longer pressed over the button */
    onMouseUp?: Callback | undefined;
    /** Adds custom/overriding styles */
    stylesheet?: unknown | undefined;
    /** Specifies where to display the linked URL */
    target?: AvailableTargets | undefined;
    /** Sets the title of a button */
    title: string;
    /** Specifies type of button */
    type?: AvailableTypes | undefined;
    /** Specifies width of button */
    width?: AvailableWidths | undefined;
}

export const availableTargets: AvailableTargets;
export const availableTypes: AvailableTypes;
export const availableWidths: AvailableWidths;
export const targets: Targets;
export const types: Types;
export const widths: Widths;

export default class Button extends React.Component<Props> {}

````

### Additional Details
 * Last updated: Wed, 06 Dec 2023 07:07:09 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Matthew Bryant](https://github.com/matthewbryant95).

---
_Source: https://npm.io/package/@types/hig__button · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
