Luminare

Luminare is a SwiftUI framework for macOS that provides pre-styled components following a consistent design language. Key characteristics include:

• Declarative Syntax: Uses a syntax consistent with standard SwiftUI.
• Modularity: Designed for reusability to minimize boilerplate when building custom interfaces.
• Consistent Styling: Utilizes a mix of system-defined and custom modifiers to ensure visual uniformity across components.

LuminareWindow provides a pre-configured window environment designed to maintain design coherence across your application.

Key characteristics:

• It features standard traffic lights (window controls) but removes the traditional title bar section.
• All window content is automatically wrapped within a LuminareView.

To achieve a standard vertically divided layout (common in sidebar-based applications), it is recommended to place a LuminareDividedStack inside the LuminareWindow.

Both components are used for selecting discrete options, but they differ in visibility and composition:

• LuminareCompactPicker (Segmented): Displays all options at the same time on the screen.
• LuminareSliderPicker: Only displays the current selection. Use this when you want the picker to compose with a label.

Deciding which picker to use depends on the layout and purpose of your selection UI:

• Use LuminareCompactPicker when you need to display options in a menu or as horizontally organized segments. It is recommended for toggling between controls (e.g., switching between light and dark modes).
• Use LuminarePicker when you want to display a grid of options. For switching between paged views, a compact 1-row LuminarePicker is preferred as it aligns better with the Luminare design language.

The LuminareStepper component supports both horizontal and vertical orientations using LuminareStepperDirection.

• Direction: You can set the orientation to horizontal or vertical. Using an alternate direction will invert the side representing arithmetically larger values.
• Alignment: Depending on the chosen direction, you can adjust the position of the indicators using LuminareStepperAlignment.

You can integrate Luminare into your macOS project using Swift Package Manager (SPM) by following these steps in Xcode:

1. Open your project in Xcode.
2. Navigate to File > Swift Packages > Add Package Dependency....
3. Enter the Luminare repository URL.
4. Select your desired version and add the package to your project.

The LuminareCompose component provides a simple way to create layouts consisting of a content area and an optional label, similar to SwiftUI's LabeledContent. You can use it within layout containers like @Row and @Column to structure your UI.

There are two primary ways to initialize it:

1. With a trailing closure for the label: Use this when you want to provide a custom view as the label.
2. With a title string: Use LuminareCompose("Title") when you only need a simple text label for the content.

// Example 1: Custom label view
LuminareCompose {
    // Content view
} label: {
    // Label view
}

// Example 2: Simple title string
LuminareCompose("Title") {
    // Content view
}