# PointerModifiers

Source: /tuil/docs/reference/packages/pointer/api/pointer-modifiers
Locale: en

interface exported by @mwillbanks/tuil-pointer.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-pointer`.

```ts
export interface PointerModifiers {
  readonly shift: boolean;
  readonly alt: boolean;
  readonly ctrl: boolean;
}
```

## Members [#members]

| Member  | Type      | Required | Description                                     | Related types |
| ------- | --------- | -------- | ----------------------------------------------- | ------------- |
| `shift` | `boolean` | Yes      | The `shift` member uses the `boolean` contract. | —             |
| `alt`   | `boolean` | Yes      | The `alt` member uses the `boolean` contract.   | —             |
| `ctrl`  | `boolean` | Yes      | The `ctrl` member uses the `boolean` contract.  | —             |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/pointer/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-pointer](/tuil/docs/reference/packages/pointer)
