wasabeef / flutter_use

Play Flutter Hooks.

^{Inspired by react-use.}

flutter pub add flutter_use

• Sensors

  • useBattery — tracks device battery state.
  • useGeolocation — tracks geo location and permission state of user's device.
  • useNetworkState — tracks the state of apps network connection.
  • useAccelerometer, useUserAccelerometer, useGyroscope, and useMagnetometer — tracks accelerometer, gyroscope, and magnetometer sensors state of user's device.
  • useOrientation — tracks state of device's screen orientation.
  • useOrientationFn — calls given function changed screen orientation of user's device.
    
    

• UI

  • useAudio — plays audio and exposes its controls.
  • useAssetVideo and useNetworkVideo — plays video, tracks its state, and exposes playback controls.
    
    

• Animations

  • useInterval — re-builds component on a set interval using Timer.periodic.
  • useTimeout — re-builds component after a timeout.
  • useTimeoutFn — calls given function after a timeout.
  • useUpdate — returns a callback, which re-builds component when called.
    
    

• Side-effects

  • useFutureRetry — useFuture with an additional retry method.
  • useDebounce — debounces a function.
  • useError — error dispatcher.
  • useException — exception dispatcher.
    
    

• Lifecycles

  • useEffectOnce — a modified useEffect hook that only runs once.
  • useLifecycles — calls mount and unmount callbacks.
  • useLogger — logs in console as component goes through life-cycles.
  • useMount — calls mount callbacks.
  • useUnmount — calls unmount callbacks.
  • useUpdateEffect — run an effect only on updates.
  • useCustomCompareEffect — run an effect depending on deep comparison of its dependencies.
    
    

• State

  • useDefault — returns the default value when state is null.
  • useLatest — returns the latest state or props.
  • usePreviousDistinct — like usePrevious but with a predicate to determine if previous should update.
  • useStateList — circularly iterates over an array.
  • useToggle and useBoolean — tracks state of a boolean.
  • useCounter and useNumber — tracks state of a number.
  • useList — tracks state of an array.
  • useMap — tracks state of a map.
  • useSet — tracks state of a Set.
  • useTextFormValidator — tracks state of an object.
  • useFirstMountState — check if current build is first.
  • useBuildsCount — count component builds.
    
    
• TBD

  • useCopyToClipboard — copies text to clipboard.
  • useEvent — subscribe to events.
  • useScroll — tracks a widget's scroll position.
  • useScrolling — tracks whether widget is scrolling.
  • useFullscreen — display an element or video full-screen.
  • useClickAway— triggers callback when user clicks outside target area.
  • usePageLeave — triggers when mouse leaves page boundaries.
  • usePermission — query permission status for apps APIs.
  • useMethods — neat alternative to useReducer.
  • useSetState — creates setState method which works like this.setState.
  • usePromise — resolves promise only while component is mounted.
  • useObservable — tracks latest value of an Observable.
  • useThrottle and useThrottleFn — throttles a function.

Unlicense — public domain.

flutter_use's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• fix: update dependency battery_plus to v6
• fix: update dependency connectivity_plus to v6
• fix: update dependency geolocator to v13
• fix: update dependency sensors_plus to v6
• fix: update kotlin monorepo to v2 (major) (org.jetbrains.kotlin:kotlin-stdlib-jdk7, org.jetbrains.kotlin:kotlin-gradle-plugin)
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore: update dependency gradle to v7.6.4
• chore: update dependency node to v17.9.1
• fix: update kotlin monorepo to v1.9.25 (org.jetbrains.kotlin:kotlin-stdlib-jdk7, org.jetbrains.kotlin:kotlin-gradle-plugin)
• chore: update actions/checkout action to v4
• chore: update dependency flutter_lints to v4
• chore: update dependency husky to v9
• chore: update dependency lint-staged to v15
• chore: update dependency melos to v6
• chore: update dependency node to v20
• build: lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore: update dependency lint-staged to v13.3.0
• fix: update dependency com.android.tools.build:gradle to v7.4.2
• chore: update dependency gradle to v8
• fix: update dependency com.android.tools.build:gradle to v8

Detected dependencies

asdf

.tool-versions

• node 17.2.0

cocoapods

packages/basic/example/ios/Podfile

packages/battery/example/ios/Podfile

packages/geolocation/example/ios/Podfile

packages/network/example/ios/Podfile

packages/sensors/example/ios/Podfile

github-actions

.github/workflows/ci.yaml

• actions/checkout v3
• subosito/flutter-action v2
• dart-lang/setup-dart v1

gradle

packages/basic/example/android/gradle.properties

packages/basic/example/android/settings.gradle

packages/basic/example/android/build.gradle

• com.android.tools.build:gradle 7.2.2
• org.jetbrains.kotlin:kotlin-gradle-plugin 1.7.10
• org.jetbrains.kotlin:kotlin-stdlib-jdk7 1.7.10

packages/basic/example/android/app/build.gradle

packages/battery/example/android/gradle.properties

packages/battery/example/android/settings.gradle

packages/battery/example/android/build.gradle

• com.android.tools.build:gradle 7.2.2
• org.jetbrains.kotlin:kotlin-gradle-plugin 1.7.10
• org.jetbrains.kotlin:kotlin-stdlib-jdk7 1.7.10

packages/battery/example/android/app/build.gradle

packages/geolocation/example/android/gradle.properties

packages/geolocation/example/android/settings.gradle

packages/geolocation/example/android/build.gradle

• com.android.tools.build:gradle 7.2.2
• org.jetbrains.kotlin:kotlin-gradle-plugin 1.7.10
• org.jetbrains.kotlin:kotlin-stdlib-jdk7 1.7.10

packages/geolocation/example/android/app/build.gradle

packages/network/example/android/gradle.properties

packages/network/example/android/settings.gradle

packages/network/example/android/build.gradle

• com.android.tools.build:gradle 7.2.2
• org.jetbrains.kotlin:kotlin-gradle-plugin 1.7.10
• org.jetbrains.kotlin:kotlin-stdlib-jdk7 1.7.10

packages/network/example/android/app/build.gradle

packages/sensors/example/android/gradle.properties

packages/sensors/example/android/settings.gradle

packages/sensors/example/android/build.gradle

• com.android.tools.build:gradle 7.2.2
• org.jetbrains.kotlin:kotlin-gradle-plugin 1.7.10
• org.jetbrains.kotlin:kotlin-stdlib-jdk7 1.7.10

packages/sensors/example/android/app/build.gradle

gradle-wrapper

packages/basic/example/android/gradle/wrapper/gradle-wrapper.properties

• gradle 7.5.1

packages/battery/example/android/gradle/wrapper/gradle-wrapper.properties

• gradle 7.5.1

packages/geolocation/example/android/gradle/wrapper/gradle-wrapper.properties

• gradle 7.5.1

packages/network/example/android/gradle/wrapper/gradle-wrapper.properties

• gradle 7.5.1

packages/sensors/example/android/gradle/wrapper/gradle-wrapper.properties

• gradle 7.5.1

nodenv

.node-version

• node 19.9.0

npm

package.json

• husky 8.0.3
• lint-staged 13.2.3
• prettier ^3.0.0

pub

packages/audio/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• just_audio ^0.9.28
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0
• flutter >=3.0.0

packages/basic/example/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0

packages/basic/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0
• flutter >=3.0.0

packages/battery/example/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0

packages/battery/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• battery_plus ^2.1.4+1
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0
• flutter >=3.0.0

packages/geolocation/example/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• geolocator ^9.0.1
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0

packages/geolocation/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• geolocator ^9.0.1
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0
• flutter >=3.0.0

packages/network/example/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0

packages/network/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• connectivity_plus ^2.3.6+1
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0
• flutter >=3.0.0

packages/sensors/example/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0

packages/sensors/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• sensors_plus ^1.2.1
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0
• flutter >=3.0.0

packages/video/pubspec.yaml

• flutter
• flutter_hooks ^0.20.0
• video_player ^2.4.6
• flutter_lints ^2.0.2
• mockito ^5.3.0
• dart >=2.17.0 <4.0.0
• flutter >=3.0.0

pubspec.yaml

• melos ^3.1.1
• dart >=2.17.0 <4.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Is this being maintained?

Is this package being maintained at all?

Flutter 3 Update

Hello! Just wanted to suggest updating to flutter 3, as I get these warnings when building, and it would be nice to be rid of them :)

Set available device orientations for specific page

Hello guys.
I want to add specific page support for a few orientations.
Depending on the orientation, the view should be different.

In common StatefullWidget we can make it with:

  @override
  void initState() {
    super.initState();

    SystemChrome.setPreferredOrientations([
      DeviceOrientation.portraitUp,
      DeviceOrientation.portraitDown,
      DeviceOrientation.landscapeRight,
      DeviceOrientation.landscapeLeft,
    ]);
  }

  @override
  void dispose() {
    SystemChrome.setPreferredOrientations([
      DeviceOrientation.portraitUp,
      DeviceOrientation.portraitDown,
    ]);
    super.dispose();
  }

But how to specify available device orientations for specific pages using flutter_hooks?

flutter_use_camera example?

Hi, great resource you have made! Solves a lot of pain points very easily. One of the big pains in the butt is setting up the camera. You have to initialize then list available cameras etc.

Any chance you can make a use_camera_hook with an example?

Thank you!