<p align="center">
  <img width="256" alt="Adwaita Icon" src="Icons/AdwaitaIcon.png">
  <h1 align="center">Adwaita</h1>
</p>

<p align="center">
  <a href="https://david-swift.gitbook.io/adwaita/">
  User Manual
  </a>
  ·
  <a href="https://github.com/AparokshaUI/Adwaita">
  GitHub
  </a>
  ·
  <a href="Documentation/Reference/README.md">
  Contributor Docs
  </a>
</p>

_Adwaita_ is a framework for creating user interfaces for GNOME with an API similar to SwiftUI.

The following code:

```swift
struct Example: View {

    @State private var count = 0

    var view: Body {
        Text("\(count)")
            .style("title-1")
            .padding(50)
            .topToolbar {
                HeaderBar.start {
                    Button(icon: .default(icon: .goPrevious)) {
                        count -= 1
                    }
                    Button(icon: .default(icon: .goNext)) {
                        count += 1
                    }
                }
            }
    }

}
```

Creates a simple counter view:

![Counter Example][image-1]

More examples are available in the [demo app][1]:

![Demo App][image-2]

## Table of Contents

- [Goals][2]
- [Widgets][3]
- [Installation][4]
- [Usage][5]
- [Thanks][6]

## Goals

_Adwaita_’s main goal is to provide an easy-to-use interface for creating GNOME apps. The backend should stay as simple as possible, while not limiting the possibilities there are with [Libadwaita][7] and [GTK][8].

If you want to use _Adwaita_ in a project, but there are widgets missing, open an [issue on GitHub][9].

## Widgets

An overview of the widgets supported by _Adwaita_ is available [here](user-manual/Information/Widgets.md).

## Installation
### Dependencies
If you are using a Linux distribution, install `libadwaita-devel` or `libadwaita` (or something similar, based on the package manager) as well as `gtk4-devel`, `gtk4` or similar.

On macOS, follow these steps:
1. Install [Homebrew][11].
2. Install Libadwaita (and thereby GTK 4):
```
brew install libadwaita
```

### Swift Package
1. Open your Swift package in GNOME Builder, Xcode, or any other IDE.
2. Open the `Package.swift` file.
3. Into the `Package` initializer, under `dependencies`, paste:
```swift
.package(url: "https://github.com/AparokshaUI/Adwaita", from: "0.1.0")   
```

## Usage

I recommend using the [template repository](https://github.com/AparokshaUI/AdwaitaTemplate) as a starting point.

* [Getting Started][12]

### Basics

* [Hello World][13]
* [Creating Views][14]
* [Windows][15]
* [Keyboard Shortcuts][16]

### Advanced

* [Creating Widgets][17]

### Information

* [Widgets](user-manual/Information/Widgets.md)

## Thanks

### Dependencies
- [Libadwaita][18] licensed under the [GPL-3.0 license][19]

### Other Thanks
- The [contributors][20]
- [SwiftLint][21] for checking whether code style conventions are violated
- The programming language [Swift][22]
- [SourceDocs][23] used for generating the [docs][24]

[1]:    Tests/
[2]:	#goals
[3]:	#widgets
[4]:	#installation
[5]:	#usage
[6]:	#thanks
[7]:	https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/index.html
[8]:	https://docs.gtk.org/gtk4/
[9]:	https://github.com/AparokshaUI/Adwaita/issues
[10]:	https://github.com/AparokshaUI/Libadwaita
[11]:	https://brew.sh
[12]:	user-manual/GettingStarted.md
[13]:	user-manual/Basics/HelloWorld.md
[14]:   user-manual/Basics/CreatingViews.md
[15]:   user-manual/Basics/Windows.md
[16]:   user-manual/Basics/KeyboardShortcuts.md
[17]:   user-manual/Advanced/CreatingWidgets.md
[18]:	https://github.com/AparokshaUI/Libadwaita
[19]:	https://github.com/AparokshaUI/Libadwaita/blob/main/LICENSE.md
[20]:	Contributors.md
[21]:	https://github.com/realm/SwiftLint
[22]:	https://github.com/apple/swift
[23]:	https://github.com/SourceDocs/SourceDocs
[24]:	Documentation/Reference/README.md

[image-1]: Icons/Screenshot.png
[image-2]: Icons/Demo.png
