diff options
Diffstat (limited to 'docs/guide')
| -rw-r--r-- | docs/guide/getting-started/introduction.md | 2 | ||||
| -rw-r--r-- | docs/guide/getting-started/nix.md | 2 | ||||
| -rw-r--r-- | docs/guide/getting-started/supported-languages.md | 2 | ||||
| -rw-r--r-- | docs/guide/typescript/cli-app.md | 2 | ||||
| -rw-r--r-- | docs/guide/typescript/faq.md | 2 | ||||
| -rw-r--r-- | docs/guide/typescript/first-widgets.md | 4 | ||||
| -rw-r--r-- | docs/guide/typescript/utilities.md | 4 | ||||
| -rw-r--r-- | docs/guide/typescript/variable.md | 4 | ||||
| -rw-r--r-- | docs/guide/typescript/widget.md | 34 |
9 files changed, 28 insertions, 28 deletions
diff --git a/docs/guide/getting-started/introduction.md b/docs/guide/getting-started/introduction.md index af176c3..782c069 100644 --- a/docs/guide/getting-started/introduction.md +++ b/docs/guide/getting-started/introduction.md @@ -6,7 +6,7 @@ Astal (_meaning "desk"_) is a suite of libraries in Vala and C. The core library [astal3](https://aylur.github.io/libastal/astal3) and [astal4](https://aylur.github.io/libastal/astal4) (not yet available) has some Gtk widgets that come packaged, -the most important one being the [Window](https://aylur.github.io/libastal/class.Window.html) which is the main toplevel component using [gtk-layer-shell](https://github.com/wmww/gtk-layer-shell). +the most important one being the [Window](https://aylur.github.io/libastal/astal3/class.Window.html) which is the main toplevel component using [gtk-layer-shell](https://github.com/wmww/gtk-layer-shell). This is what allows us to use Gtk as shell components on Wayland. The other part of the core library [astal-io](https://aylur.github.io/libastal/astal-io) which contains some utility GLib shortcut for running external processes, diff --git a/docs/guide/getting-started/nix.md b/docs/guide/getting-started/nix.md index 5c0db28..1d50d35 100644 --- a/docs/guide/getting-started/nix.md +++ b/docs/guide/getting-started/nix.md @@ -88,7 +88,7 @@ Using Astal on Nix will require you to package your project. ## AGS -The recommended way to use [AGS](../ags/first-widgets#first-widgets) on NixOS is through the home-manager module. +The recommended way to use [AGS](../typescript/first-widgets#first-widgets) on NixOS is through the home-manager module. Example content of a `flake.nix` file that contains your `homeConfigurations`. diff --git a/docs/guide/getting-started/supported-languages.md b/docs/guide/getting-started/supported-languages.md index 47d5dbd..d6d669d 100644 --- a/docs/guide/getting-started/supported-languages.md +++ b/docs/guide/getting-started/supported-languages.md @@ -7,7 +7,7 @@ Gtk by implementing a state management and UI declaring solution. ## JavaScript The main intended usage of Astal is in TypeScript+JSX. -It is recommended to use [AGS](/guide/ags/first-widgets) to scaffold and run projects in TypeScript. +It is recommended to use [AGS](/guide/typescript/first-widgets) to scaffold and run projects in TypeScript. However, if you are familiar with JavaScript's tooling ecosystem you can also setup an environment yourself. Only a minimal knowledge of JavaScript's syntax is needed to get started. diff --git a/docs/guide/typescript/cli-app.md b/docs/guide/typescript/cli-app.md index 3407e06..f409176 100644 --- a/docs/guide/typescript/cli-app.md +++ b/docs/guide/typescript/cli-app.md @@ -1,6 +1,6 @@ # CLI and App -`App` is a singleton **instance** of an [Astal.Application](https://aylur.github.io/libastal/class.Application.html). +`App` is a singleton **instance** of an [Astal.Application](https://aylur.github.io/libastal/astal3/class.Application.html). Depending on gtk version import paths will differ diff --git a/docs/guide/typescript/faq.md b/docs/guide/typescript/faq.md index 76d8e72..48c802c 100644 --- a/docs/guide/typescript/faq.md +++ b/docs/guide/typescript/faq.md @@ -204,7 +204,7 @@ notifd.get_notifications() // ✅ ## How to create regular floating windows -Use `Gtk.Window` with [Widget.astalify](/guide/ags/widget#how-to-use-non-builtin-gtk-widgets). +Use `Gtk.Window` with [Widget.astalify](/guide/typescript/widget#how-to-use-non-builtin-gtk-widgets). By default `Gtk.Window` is destroyed on close. To prevent this add a handler for `delete-event`. diff --git a/docs/guide/typescript/first-widgets.md b/docs/guide/typescript/first-widgets.md index 3664bfa..a7372a8 100644 --- a/docs/guide/typescript/first-widgets.md +++ b/docs/guide/typescript/first-widgets.md @@ -42,7 +42,7 @@ The AGS init command will generate the following files Astal apps are composed of widgets. A widget is a piece of UI that has its own logic and style. A widget can be as small as a button or an entire bar. -The top level widget is always a [Window](https://aylur.github.io/libastal/class.Window.html) which will hold all widgets. +The top level widget is always a [Window](https://aylur.github.io/libastal/astal3/class.Window.html) which will hold all widgets. ::: code-group @@ -363,7 +363,7 @@ by setting `noImplicityDestroy` property on the container widget. :::info The above example destroys and recreates every widget in the list **every time** the value of the `Variable` changes. There might be cases where you would -want to [handle child creation and deletion](/guide/ags/faq#avoiding-unnecessary-re-rendering) +want to [handle child creation and deletion](/guide/typescript/faq#avoiding-unnecessary-re-rendering) yourself, because you don't want to lose the inner state of widgets that does not need to be recreated. In this case you can create a [custom reactive structure](./binding#example-custom-subscribable) diff --git a/docs/guide/typescript/utilities.md b/docs/guide/typescript/utilities.md index 9bc56b2..f808044 100644 --- a/docs/guide/typescript/utilities.md +++ b/docs/guide/typescript/utilities.md @@ -44,7 +44,7 @@ import { interval, timeout, idle } from "astal" You can use javascript native `setTimeout` or `setInterval` they return a [GLib.Source](https://docs.gtk.org/glib/struct.Source.html) instance. Alternatively you can use these functions provided by Astal, -which return an [Astal.Time](https://aylur.github.io/libastal/class.Time.html) instance. +which return an [Astal.Time](https://aylur.github.io/libastal/io/class.Time.html) instance. `Astal.Time` has a `now` signal and a `cancelled` signal. @@ -99,7 +99,7 @@ import { subprocess, exec, execAsync } from "astal" ### Subprocess You can start a subprocess and run callback functions whenever it outputs to -stdout or stderr. [Astal.Process](https://aylur.github.io/libastal/class.Process.html) has a `stdout` and `stderr` signal. +stdout or stderr. [Astal.Process](https://aylur.github.io/libastal/io/class.Process.html) has a `stdout` and `stderr` signal. ```ts function subprocess(args: { diff --git a/docs/guide/typescript/variable.md b/docs/guide/typescript/variable.md index 4207f61..2abacbd 100644 --- a/docs/guide/typescript/variable.md +++ b/docs/guide/typescript/variable.md @@ -8,7 +8,7 @@ Variable is just a simple object which holds a single value. It also has some shortcuts for hooking up subprocesses, intervals and other gobjects. :::info -The `Variable` object imported from the `"astal"` package is **not** [Astal.Variable](https://aylur.github.io/libastal/class.Variable.html). +The `Variable` object imported from the `"astal"` package is **not** [Astal.Variable](https://aylur.github.io/libastal/io/class.Variable.html). ::: ## Example Usage @@ -75,7 +75,7 @@ output. They can poll and watch at the same time, but they can only poll/watch once. :::warning -The command parameter is passed to [execAsync](/guide/ags/utilities#executing-external-commands-and-scripts) +The command parameter is passed to [execAsync](/guide/typescript/utilities#executing-external-commands-and-scripts) which means they are **not** executed in a shell environment, they do **not** expand ENV variables like `$HOME`, and they do **not** handle logical operators like `&&` and `||`. diff --git a/docs/guide/typescript/widget.md b/docs/guide/typescript/widget.md index 03ba9ea..d16d194 100644 --- a/docs/guide/typescript/widget.md +++ b/docs/guide/typescript/widget.md @@ -191,23 +191,23 @@ You can check the [source code](https://github.com/aylur/astal/blob/main/lang/gj These widgets are available by default in JSX. -- box: [Astal.Box](https://aylur.github.io/libastal/class.Box.html) -- button: [Astal.Button](https://aylur.github.io/libastal/class.Button.html) -- centerbox: [Astal.CenterBox](https://aylur.github.io/libastal/class.CenterBox.html) -- circularprogress: [Astal.CircularProgress](https://aylur.github.io/libastal/class.CircularProgress.html) -- drawingarea: [Gtk.DrawingArea](https://docs.gtk.org/gtk3/class.DrawingArea.html) -- entry: [Gtk.Entry](https://docs.gtk.org/gtk3/class.Entry.html) -- eventbox: [Astal.EventBox](https://aylur.github.io/libastal/class.EventBox.html) -- icon: [Astal.Icon](https://aylur.github.io/libastal/class.Icon.html) -- label: [Astal.Label](https://aylur.github.io/libastal/class.Label.html) -- levelbar: [Astal.LevelBar](https://aylur.github.io/libastal/class.LevelBar.html) -- overlay: [Astal.Overlay](https://aylur.github.io/libastal/class.Overlay.html) -- revealer: [Gtk.Revealer](https://docs.gtk.org/gtk3/class.Revealer.html) -- scrollable: [Astal.Scrollable](https://aylur.github.io/libastal/class.Scrollable.html) -- slider: [Astal.Slider](https://aylur.github.io/libastal/class.Slider.html) -- stack: [Astal.Stack](https://aylur.github.io/libastal/class.Stack.html) -- switch: [Gtk.Switch](https://docs.gtk.org/gtk3/class.Switch.html) -- window: [Astal.Window](https://aylur.github.io/libastal/class.Window.html) +- box: [Astal.Box](https://aylur.github.io/libastal/astal3/class.Box.html) +- button: [Astal.Button](https://aylur.github.io/libastal/astal3/class.Button.html) +- centerbox: [Astal.CenterBox](https://aylur.github.io/libastal/astal3/class.CenterBox.html) +- circularprogress: [Astal.CircularProgress](https://aylur.github.io/libastal/astal3/class.CircularProgress.html) +- drawingarea: [Gtk.DrawingArea](https://docs.gtk.org/gtk3/astal3/class.DrawingArea.html) +- entry: [Gtk.Entry](https://docs.gtk.org/gtk3/astal3/class.Entry.html) +- eventbox: [Astal.EventBox](https://aylur.github.io/libastal/astal3/class.EventBox.html) +- icon: [Astal.Icon](https://aylur.github.io/libastal/astal3/class.Icon.html) +- label: [Astal.Label](https://aylur.github.io/libastal/astal3/class.Label.html) +- levelbar: [Astal.LevelBar](https://aylur.github.io/libastal/astal3/class.LevelBar.html) +- overlay: [Astal.Overlay](https://aylur.github.io/libastal/astal3/class.Overlay.html) +- revealer: [Gtk.Revealer](https://docs.gtk.org/gtk3/astal3/class.Revealer.html) +- scrollable: [Astal.Scrollable](https://aylur.github.io/libastal/astal3/class.Scrollable.html) +- slider: [Astal.Slider](https://aylur.github.io/libastal/astal3/class.Slider.html) +- stack: [Astal.Stack](https://aylur.github.io/libastal/astal3/class.Stack.html) +- switch: [Gtk.Switch](https://docs.gtk.org/gtk3/astal3/class.Switch.html) +- window: [Astal.Window](https://aylur.github.io/libastal/astal3/class.Window.html) ## Gtk4 |