Declaration
function useEnvironmentObject<T extends ObservableObject>(
type: ObservableObjectType<T>
): Observed<T>Parameters
type*ObservableObjectType<T>
Discussion
@example const session = useEnvironmentObject(Session); return Name;
See also
More in Hooks.
- useBindable@Bindable: tracks reads like useObservable, and gives a Binding to each property under $name: <TextField text={book.$title} /.
- useBindingCreates a Binding object that can be used to read and write to a value. Components can recieve a binding as a prop and can handle the logic of getting and setting the value from inside the component.
- useEnvironment@Environment(Model.self): reads the Observable an ancestor supplied with .environment(model). The component re-renders only when a property it read changes. With { optional: true }, like Model?.self, a missing object gives null instead of throwing.
- useFocusedObject@FocusedObject: the object of this type that the focused view, one of its ancestors, or the focused scene publishes with focusedObject or focusedSceneObject, or null. The component re-renders when focus moves and when the object changes.
- useFocusedValue@FocusedValue(Model.self): the Observable of this type that the focused view, one of its ancestors, or the focused scene publishes with focusedValue or focusedSceneValue, or null. The component re-renders when focus moves and when a property it read changes.
- useObservableReads an Observable the way a SwiftUI body does: the component re-renders only when a property it read changes. Pass the object from props, state or anywhere else.
- useObservedObject@ObservedObject: re-renders the component whenever the object changes.
- useStateObject@StateObject: creates the object once for the component's lifetime, and observes it.