@@ -5,7 +5,7 @@ title: KeyStateTracker
55
66# Class: KeyStateTracker
77
8- Defined in: [ key-state.ts:63] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L63 )
8+ Defined in: [ key-state-tracker .ts:63] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L63 )
99
1010Singleton tracker for currently held keyboard keys.
1111
@@ -49,7 +49,7 @@ unsubscribe()
4949readonly store : Store < KeyStateTrackerState > ;
5050```
5151
52- Defined in: [ key-state.ts:70] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L70 )
52+ Defined in: [ key-state-tracker .ts:70] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L70 )
5353
5454The TanStack Store instance containing the tracker state.
5555Use this to subscribe to state changes or access current state.
@@ -62,7 +62,7 @@ Use this to subscribe to state changes or access current state.
6262areAllKeysHeld (keys ): boolean ;
6363```
6464
65- Defined in: [ key-state.ts:209] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L209 )
65+ Defined in: [ key-state-tracker .ts:209] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L209 )
6666
6767Checks if all of the given keys are currently held.
6868
@@ -88,7 +88,7 @@ True if all of the keys are currently held
8888destroy (): void ;
8989```
9090
91- Defined in: [ key-state.ts:233] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L233 )
91+ Defined in: [ key-state-tracker .ts:233] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L233 )
9292
9393Destroys the tracker and removes all listeners.
9494
@@ -104,7 +104,7 @@ Destroys the tracker and removes all listeners.
104104getHeldKeys (): string [];
105105```
106106
107- Defined in: [ key-state.ts:178] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L178 )
107+ Defined in: [ key-state-tracker .ts:178] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L178 )
108108
109109Gets an array of currently held key names.
110110
@@ -122,7 +122,7 @@ Array of key names currently being pressed
122122isAnyKeyHeld (keys ): boolean ;
123123```
124124
125- Defined in: [ key-state.ts:199] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L199 )
125+ Defined in: [ key-state-tracker .ts:199] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L199 )
126126
127127Checks if any of the given keys are currently held.
128128
@@ -148,7 +148,7 @@ True if any of the keys are currently held
148148isKeyHeld (key ): boolean ;
149149```
150150
151- Defined in: [ key-state.ts:188] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L188 )
151+ Defined in: [ key-state-tracker .ts:188] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L188 )
152152
153153Checks if a specific key is currently being held.
154154
@@ -174,7 +174,7 @@ True if the key is currently held
174174subscribe (listener ): () => void ;
175175```
176176
177- Defined in: [ key-state.ts:220] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L220 )
177+ Defined in: [ key-state-tracker .ts:220] ( https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L220 )
178178
179179Subscribes to key state changes.
180180
@@ -210,7 +210,7 @@ Use `tracker.store.subscribe()` or `useStore()` from `@tanstack/react-store` ins
210210static getInstance (): KeyStateTracker ;
211211` ` `
212212
213- Defined in: [key-state.ts:86](https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L86)
213+ Defined in: [key-state-tracker .ts:86](https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L86)
214214
215215Gets the singleton instance of KeyStateTracker.
216216
@@ -226,7 +226,7 @@ Gets the singleton instance of KeyStateTracker.
226226static resetInstance (): void ;
227227` ` `
228228
229- Defined in: [key-state.ts:96](https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state.ts#L96)
229+ Defined in: [key-state-tracker .ts:96](https://github.com/TanStack/keys/blob/main/packages/keys/src/key-state-tracker .ts#L96)
230230
231231Resets the singleton instance. Useful for testing.
232232
0 commit comments