TimelineView

A view that updates according to a schedule that you provide.

ComponentiOS 15.0+macOS 12.0+tvOS 15.0+watchOS 8.0+TimelineView in SwiftUI

Declaration

React
import { TimelineView } from 'swiftui-react-native';
Swift
struct TimelineView<Schedule, Content> where Schedule : TimelineSchedule

Initializers

One SwiftUI initializer backs <TimelineView>.

React
<TimelineView
  schedule: SwiftUI.TimelineSchedule
>
  children?: ReactNode | ((arg0: SwiftUI.TimelineViewDefaultContext) => ReactNode)
</TimelineView>
Swift
@export(implementation) nonisolated init(
    _ schedule: Schedule,
    @ContentBuilder content: @escaping (TimelineViewDefaultContext) -> Content
)
  • A schedule that produces a sequence of dates that indicate the instances when the view should update. Use a type that conforms to [TimelineSchedule](/docs/values/timelineschedule), like TimelineSchedule/everyMinute, or a custom timeline schedule that you define.

  • childrenReactNode | ((arg0: SwiftUI.TimelineViewDefaultContext) => ReactNode)

    A closure that generates view content at the moments indicated by the schedule. The closure takes an input of type [TimelineViewDefaultContext](/docs/values/timelineviewdefaultcontext) that includes the date from the schedule that prompted the update, as well as a Context/Cadence-swift.enum value that the view can use to customize its appearance.

    Swift content: (TimelineViewDefaultContext) -> Content

Also takes the common view props: modifiers, style and testID.

Overview

A timeline view acts as a container with no appearance of its own. Instead, it redraws the content it contains at scheduled points in time. For example, you can update the face of an analog timer once per second:

TimelineView(.periodic(from: startDate, by: 1)) { context in
    AnalogTimerView(date: context.date)
}

The closure that creates the content receives an input of type Context that you can use to customize the content's appearance. The context includes the Context.date that triggered the update. In the example above, the timeline view sends that date to an analog timer that you create so the timer view knows how to draw the hands on its face.

The context also includes a Context.cadence-swift.property property that you can use to hide unnecessary detail. For example, you can use the cadence to decide when it's appropriate to display the timer's second hand:

TimelineView(.periodic(from: startDate, by: 1.0)) { context in
    AnalogTimerView(
        date: context.date,
        showSeconds: context.cadence <= .seconds)
}

The system might use a cadence that's slower than the schedule's update rate. For example, a view on watchOS might remain visible when the user lowers their wrist, but update less frequently, and thus require less detail.

You can define a custom schedule by creating a type that conforms to the TimelineSchedule protocol, or use one of the built-in schedule types:

For a schedule containing only dates in the past, the timeline view shows the last date in the schedule. For a schedule containing only dates in the future, the timeline draws its content using the current date until the first scheduled date arrives.

From Apple’s SwiftUI documentation. Code samples there are Swift.

Relationships

Conforms to

  • Swift.Copyable
  • Swift.Escapable
  • View

See also

More in Views.