marquiskurt/adwaita-swift
1
0
Fork 0
forked from aparoksha/adwaita-swift
Code Pull Requests Activity

Support editing a widget only when it appears

Browse Source
This commit is contained in:
david-swift 2024-01-02 08:25:14 +01:00
parent 26b46e3338
commit 350580269f
2 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Sources/Adwaita/View/Modifiers/AppearObserver.swift
View File

@ -11,7 +11,7 @@ import Libadwaita
struct AppearObserver: Widget { struct AppearObserver: Widget {
/// The function. /// The function.
var onAppear: () -> Void var onAppear: (NativeWidgetPeer) -> Void
/// The content. /// The content.
var content: View var content: View
@ -19,8 +19,9 @@ struct AppearObserver: Widget {
/// - Parameter modifiers: Modify views before being updated. /// - Parameter modifiers: Modify views before being updated.
/// - Returns: The content's container. /// - Returns: The content's container.
func container(modifiers: [(View) -> View]) -> ViewStorage { func container(modifiers: [(View) -> View]) -> ViewStorage {
onAppear() let storage = content.storage(modifiers: modifiers)
return content.storage(modifiers: modifiers) onAppear(storage.view)
return storage
} }
/// Update the content. /// Update the content.
@ -35,11 +36,18 @@ struct AppearObserver: Widget {
extension View { extension View {
/// Run a function on the widget when it appears for the first time.
/// - Parameter closure: The function.
/// - Returns: A view.
public func inspectOnAppear(_ closure: @escaping (NativeWidgetPeer) -> Void) -> View {
AppearObserver(onAppear: closure, content: self)
}
/// Run a function when the view appears for the first time. /// Run a function when the view appears for the first time.
/// - Parameter closure: The function. /// - Parameter closure: The function.
/// - Returns: A view. /// - Returns: A view.
public func onAppear(_ closure: @escaping () -> Void) -> View { public func onAppear(_ closure: @escaping () -> Void) -> View {
AppearObserver(onAppear: closure, content: self) inspectOnAppear { _ in closure() }
} }
} }

1
user-manual/Information/Widgets.md
View File

@ -38,6 +38,7 @@ This is an overview of the available widgets and other components in _Adwaita_.
| `navigationTitle(_:)` | Add a title that is used if the view is a direct child of a NavigationView. | | `navigationTitle(_:)` | Add a title that is used if the view is a direct child of a NavigationView. |
| `style(_:)` | Add a style class to the view. | | `style(_:)` | Add a style class to the view. |
| `onAppear(_:)` | Run when the view is rendered for the first time. | | `onAppear(_:)` | Run when the view is rendered for the first time. |
| `inspectOnAppear(_:)` | Edit the underlying [Libadwaita][10] class when the view is rendered for the first time.|
| `topToolbar(visible:_:)` | Add a native toolbar to the view. Normally, it contains a HeaderBar. | | `topToolbar(visible:_:)` | Add a native toolbar to the view. Normally, it contains a HeaderBar. |
| `bottomToolbar(visible:_:)` | Add a native bottom toolbar to the view. | | `bottomToolbar(visible:_:)` | Add a native bottom toolbar to the view. |
| `modifyContent(_:modify:)` | Replace all occurrences of a certain view type with another view. | | `modifyContent(_:modify:)` | Replace all occurrences of a certain view type with another view. |