EnvironmentValues

public extension EnvironmentValues

  • This property indicates if the calendar view also shows the week number of not. The default is false.

    Declaration

    Swift

    var showsWeekNumbers: Bool { get set }

  • Specifies if the event indicator view is displayed

    Declaration

    Swift

    var hasEventIndicator: Bool { get set }

  • The ID of the language to be used when displaying the CalendarView.

    Declaration

    Swift

    var customLanguageId: String? { get set }

  • Custom bundle.

    Declaration

    Swift

    var customBundle: Bundle? { get set }

  • The type of secondary calendar to be displayed.

    The default is .none, meaning that there is no secondary calendar to be displayed.

    Declaration

    Swift

    var alternateCalendarType: AlternateCalendarType { get set }

  • The Locale to be used for alternate calendar.

    The default is nil which means the corresponding default Locale for the secondary calendar is used.

    Declaration

    Swift

    var alternateCalendarLocale: Locale? { get set }

  • The color of the view displayed upon selection of a date.

    Declaration

    Swift

    var selectionSingleColor: Color { get set }

  • The color of the view displayed upon a range selection of dates

    Declaration

    Swift

    var selectionRangeColor: Color { get set }

  • The color of the eventView displayed below each date.

    Declaration

    Swift

    var eventViewColor: Color { get set }

  • The color of the eventView displayed below each date for disabled dates.

    Declaration

    Swift

    var eventViewColorDisabled: Color { get set }

  • The color of calendar item in different state, only support foregroundColor.

    For .weekDayText, only .normal and .highlighted states will be used. For .monthHeaderText, only .normal state will be used. For .weekNumberText, only .normal state will be used.

    Declaration

    Swift

    var calendarItemTintAttributes: [CalendarPropertyRef : [CalendarItemControlState : Color]] { get set }

  • The date formatter for month header. Default is “MMMM”

    Declaration

    Swift

    var monthHeaderDateFormat: String { get set }

  • The backgroundColor for banner message

    Declaration

    Swift

    var bannerMessageBackgroundColor: Color? { get set }

  • A property that provides access to the selection mode for hierarchical items.

    The hierarchyItemSelectionMode property allows you to retrieve or set the selection mode for hierarchical items in HierarchyView and HierarchyItemView. This enables you to control how users can interact with items in a hierarchy (e.g., selecting items in a tree view or nested list).

    Note

    The selection mode is defined by the HierarchyItemSelectionMode enum, which supports three modes: none, single, and multiple.

    Declaration

    Swift

    var hierarchyItemSelectionMode: HierarchyItemSelectionMode { get set }

  • The closure used to create and configure the underlying standard Button<EmptyView> in FioriButton.

    Use this to apply Apple’s Button features (e.g., role: .destructive).

    Declaration

    Swift

    var standardButtonCreator: ButtonCreator { get set }

  • Set max number of items that can be displayed in a component.

    Supported components:

    • MenuSelection

    Declaration

    Swift

    var maxNumberOfItems: Int { get set }

  • Undocumented

    Declaration

    Swift

    var isCustomizedBorder: Bool { get set }

  • get / set isInMenu value in the environment. Can be used to determine if the component such as a FioriButton is put inside a Menu.

    Declaration

    Swift

    var isInMenu: Bool { get set }

  • A Boolean value indicating whether content is currently loading. It can be used to show the shimmer effect.

    Declaration

    Swift

    var isLoading: Bool { get set }

  • A Boolean value indicating whether AI content is currently loading. It can be used to show the tint color for shimmer effect.

    Declaration

    Swift

    var isAILoading: Bool { get set }

  • Distribution of left and right content columns, when in .regular horizontal content mode. Defaults to 0.5.

    Declaration

    Swift

    var splitPercent: CGFloat? { get set }

  • The avatars border color. Default value is clear.

    Declaration

    Swift

    var avatarBorderColor: Color { get set }

  • Dimensions of the avatars border width. Default value is 0.

    Declaration

    Swift

    var avatarBorderWidth: CGFloat { get set }

  • Specifies whether the avatars are drawn as circular. Default value is true.

    Declaration

    Swift

    var isAvatarCircular: Bool { get set }

  • Dimensions of avatars size. Default value is 45x45 for group, and 16x16 for horizontal avatars.

    Declaration

    Swift

    var avatarSize: CGSize? { get set }

  • Title position of avatar stack. Default value is trailing.

    Declaration

    Swift

    var avatarsTitlePosition: AvatarStack.TextPosition { get set }

  • Layout for avatars in the stack. Default value is .grouped.

    Declaration

    Swift

    var avatarsLayout: AvatarStack.Layout { get set }

  • Max count for avatars in the stack. Default value is nil.

    Declaration

    Swift

    var avatarsMaxCount: Int? { get set }

  • Spacing for avatars in horizontal stack. Default value is -1.

    Declaration

    Swift

    var avatarsSpacing: CGFloat { get set }

  • Attributes for filter form option, include foregroundColor, backgroundColor, font, strokeColor and strokeWidth.

    Declaration

    Swift

    var filterFormOptionAttributes: [FilterFormOptionState : [NSAttributedString.Key : Any]] { get set }

  • Minimum height for filter form option.

    Declaration

    Swift

    var filterFormOptionMinHeight: CGFloat { get set }

  • Minimum touch area height for filter form option.

    Declaration

    Swift

    var filterFormOptionMinTouchHeight: CGFloat { get set }

  • Corner radius for filter form option.

    Declaration

    Swift

    var filterFormOptionCornerRadius: CGFloat { get set }

  • Padding for filter form option.

    Declaration

    Swift

    var filterFormOptionPadding: EdgeInsets { get set }

  • Spacing between title and the checkmark for filter form option.

    Declaration

    Swift

    var filterFormOptionTitleSpacing: CGFloat { get set }

  • Item spacing for filter form options.

    Declaration

    Swift

    var filterFormOptionsItemSpacing: CGFloat { get set }

  • Line spacing for filter form options.

    Declaration

    Swift

    var filterFormOptionsLineSpacing: CGFloat { get set }

  • Maximum number of the footnote icons. Default value is 0. When the count is less or equal to 0, means the number is unlimited.

    Declaration

    Swift

    var footnoteIconsMaxCount: Int { get set }

  • Specifies whether the footnoteIcons are drawn as circular. Default value is true.

    Declaration

    Swift

    var isFootnoteIconsCircular: Bool { get set }

  • Dimensions of the footnote icons spacing. Default value is -2.

    Declaration

    Swift

    var footnoteIconsSpacing: CGFloat { get set }

  • Dimensions of footnote icons. Default value is 16x16.

    Declaration

    Swift

    var footnoteIconsSize: CGSize { get set }

  • Text position for footnote icons.

    Declaration

    Swift

    var footnoteIconsTextPosition: AvatarStack.TextPosition { get set }

  • Whether the order of items in KPIHeader is forced or not.

    Declaration

    Swift

    var isItemOrderForced: Bool { get set }

  • The value for the inter item spacing of items in KPIHeader.

    Declaration

    Swift

    var interItemSpacing: CGFloat? { get set }

  • listBackground environment value

    Declaration

    Swift

    var listBackground: Color { get set }

  • Font for filter feedback bar item.

    Declaration

    Swift

    var filterFeedbackBarItemFont: Font { get set }

  • Foreground color for filter feedback bar item selected state.

    Declaration

    Swift

    var filterFeedbackBarItemSelectedForegroundColor: Color { get set }

  • Foreground color for filter feedback bar item unselected state.

    Declaration

    Swift

    var filterFeedbackBarItemUnselectedForegroundColor: Color { get set }

  • Spacing for filter feedback bar item.

    Declaration

    Swift

    var filterFeedbackBarItemSpacing: CGFloat { get set }

  • Padding for filter feedback bar item.

    Declaration

    Swift

    var filterFeedbackBarItemPadding: CGFloat { get set }

  • Max width for filter feedback bar item.

    Declaration

    Swift

    var filterFeedbackBarItemMaxWidth: CGFloat { get set }

  • Minimum height for filter feedback bar item.

    Declaration

    Swift

    var filterFeedbackBarItemMinHeight: CGFloat { get set }

  • Corner radius for filter feedback bar item.

    Declaration

    Swift

    var filterFeedbackBarItemCornerRadius: CGFloat { get set }

  • Fill color for filter feedback bar item background selected state.

    Declaration

    Swift

    var filterFeedbackBarItemBackgroundSelectedFillColor: Color { get set }

  • Fill color for filter feedback bar item background unselected state.

    Declaration

    Swift

    var filterFeedbackBarItemBackgroundUnselectedFillColor: Color { get set }

  • Stroke color for filter feedback bar item background selected state.

    Declaration

    Swift

    var filterFeedbackBarItemBackgroundSelectedStrokeColor: Color { get set }

  • Stroke color for filter feedback bar item background unselected state.

    Declaration

    Swift

    var filterFeedbackBarItemBackgroundUnselectedStrokeColor: Color { get set }

  • Border width for filter feedback bar item.

    Declaration

    Swift

    var filterFeedbackBarItemBorderWidth: CGFloat { get set }

  • Step separator line environment value for SingleStep.

    Declaration

    Swift

    var stepLineModifier: AnyViewModifier { get set }

  • Determine the relative positioning of an icon within the TextOrIcon when both a text and an icon are present. . The default is .leading. .center and .trailing means .trailing.

    Declaration

    Swift

    var iconHorizontalAlignment: HorizontalAlignment { get set }

  • Progress view style.

    Declaration

    Swift

    var kpiProgressViewStyle: AnyKPIProgressViewStyle { get set }

  • Undocumented

    Declaration

    Swift

    var numberOfLines: Int { get set }

  • Sets the button width mode for CardFooter.

    Declaration

    Swift

    var cardFooterButtonWidthMode: CardFooterButtonWidthMode { get set }

  • The formatter for duration picker.

    Declaration

    Swift

    var measurementFormatter: MeasurementFormatter { get set }

  • Title position of loading indicator. Default value is top.

    Declaration

    Swift

    var indicatorPosition: LoadingIndicator.Layout { get set }

  • The control size of the loading indicator. Default value is .regular.

    Declaration

    Swift

    var indicatorControlSize: ControlSize { get set }

  • The tint color of loading indicator. Default value is .quaternaryLabel.

    Declaration

    Swift

    var indicatorTint: Color { get set }

Extension Documentation

  • A boolean value that indicates whether the sidebar should auto-adjust its width according to parent’s available space.

    Declaration

    Swift

    var isSidebarAutoWidth: Bool { get set }

  • The total width of the sidebar, inclusive of leading and trailing padding. It only takes effect when isSidebarAutoWidth is set to false.

    Declaration

    Swift

    var sidebarWidth: CGFloat { get set }

  • The leading padding value for the sidebar.

    Declaration

    Swift

    var sidebarLeadingPadding: CGFloat { get set }

  • The trailing padding value for the sidebar.

    Declaration

    Swift

    var sidebarTrailingPadding: CGFloat { get set }

  • Indicate whether to show vertical content in StepProgressIndicator. Allow to control the presentation state of vertical content in StepProgressIndicator programmatically.

    Declaration

    Swift

    var isSPIVerticalContentPresented: Binding<Bool> { get set }

Tag convenience initializers