Skip to content

Commit

Permalink
Docs: Fix outdated links (#116)
Browse files Browse the repository at this point in the history
mostly refactors from club.sk1er to gg.essential
  • Loading branch information
Karkkikuppi authored Jan 17, 2024
1 parent 22db718 commit 67ca997
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions docs/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ and `stroke-linejoin` attributes from the topmost `<svg>` element in your SVG fi

### PlotComponent

The [PlotComponent](../src/main/kotlin/gg/essential/elementa/components/graph/PlotComponent.kt), as its name implies,
The [PlotComponent](../src/main/kotlin/gg/essential/elementa/components/plot/PlotComponent.kt), as its name implies,
allow the user to display a graph of information to the user. The great thing about this component is that it is
extremely customizable. Everything can be changed, from the axis labels to the line widths. Lets look at a basic
example:
Expand Down Expand Up @@ -610,7 +610,7 @@ PlotComponent(
),
xBounds = Bounds(0, 6, 7, showLabels = true, labelColor = Color(101, 101, 101)),
yBounds = Bounds(0, 10, 4, showLabels = true, labelColor = Color(101, 101, 101)),
style = GraphStyle(
style = PlotStyle(
lineStyle = LineStyle(color = Color(1, 165, 82), width = 3f),
padding = Padding(10, 6, 10, 4)
)
Expand All @@ -621,8 +621,8 @@ Now we can see the true power of this component -- with only six lines of stylin

![cool graph component](https://i.imgur.com/KqTlBZ1.png)

The `GraphStyle` class has many more configuration options that aren't shown above. Check it out
[here](../src/main/kotlin/gg/essential/elementa/components/graph/GraphStyle.kt)!
The `PlotStyle` class has many more configuration options that aren't shown above. Check it out
[here](../src/main/kotlin/gg/essential/elementa/components/plot/PlotStyle.kt)!

### TreeListComponent

Expand Down
16 changes: 8 additions & 8 deletions docs/whatsnew.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

### TextInput

There are two newly updated TextInput components now: [UITextInput](../src/main/kotlin/club/sk1er/elementa/components/input/UITextInput.kt)
and [UIMultilineTextInput](../src/main/kotlin/club/sk1er/elementa/components/input/UIMultilineTextInput.kt). These are
There are two newly updated TextInput components now: [UITextInput](../src/main/kotlin/gg/essential/elementa/components/input/UITextInput.kt)
and [UIMultilineTextInput](../src/main/kotlin/gg/essential/elementa/components/input/UIMultilineTextInput.kt). These are
very powerful and useful classes. Read more about these components and how to use them [here](components.md#textinput).

### Inspector
Expand All @@ -21,25 +21,25 @@ rich text. Read more about the features of the `MarkdownComponent` and how to us

### PlotComponent

The [PlotComponent](../src/main/kotlin/club/sk1er/elementa/components/graph/PlotComponent.kt) allows the user to
The [PlotComponent](../src/main/kotlin/gg/essential/elementa/components/plot/PlotComponent.kt) allows the user to
display an extremely customizable point graph. Nearly every aspect of the way the graph is drawn is configurable. Read more
[here](components.md#PlotComponent)

### TreeListComponent

Added a new [TreeListComponent](../src/main/kotlin/club/sk1er/elementa/components/TreeListComponent.kt) component. It is
Added a new [TreeListComponent](../src/main/kotlin/gg/essential/elementa/components/TreeListComponent.kt) component. It is
used to display tree-like information in a collapsible list-like hierarchy. This is the primary component used by the
Inspector, and is highly customizable. Read more [here](components.md#TreeListComponent)

### TreeGraphComponent

The [TreeGraphComponent](../src/main/kotlin/club/sk1er/elementa/components/TreeGraphComponent.kt) displays nodes in a
The [TreeGraphComponent](../src/main/kotlin/gg/essential/elementa/components/TreeGraphComponent.kt) displays nodes in a
top-down tree view. It shows the exact same information as the `TreeListComponent` but in a different visual style. Read
more [here](components.md#TreeGraphComponent).

### WindowScreen

There is now a [WindowScreen](../src/main/kotlin/club/sk1er/elementa/WindowScreen.kt) class provided for an easy way to
There is now a [WindowScreen](../src/main/kotlin/gg/essential/elementa/WindowScreen.kt) class provided for an easy way to
avoid the boilerplate of calling all of the `Window` events manually. Rather than extending `GuiScreen` (or `Screen` in
new Minecraft versions) in your GUI class, you can simply extend `WindowScreen` and not worry about overriding the
`keyTyped`, `mouseReleased`, etc. methods. Additionally, it automatically declares a `Window` instance for you to use,
Expand Down Expand Up @@ -121,12 +121,12 @@ Pixel constraint now allows changing of the pixel value dynamically with `PixelC

### MousePositionConstraint

Added the [MousePositionConstraint](../src/main/kotlin/club/sk1er/elementa/constraints/MousePositionConstraint.kt) which
Added the [MousePositionConstraint](../src/main/kotlin/gg/essential/elementa/constraints/MousePositionConstraint.kt) which
will evaluate to the current mouse X/Y position.

### ChildBasedRangeConstraint

Added the [ChildBasedRangeConstraint](../src/main/kotlin/club/sk1er/elementa/constraints/ChildBasedConstraints.kt) which
Added the [ChildBasedRangeConstraint](../src/main/kotlin/gg/essential/elementa/constraints/ChildBasedConstraints.kt) which
evaluates the width/height difference between the component's two furthest children. This constraint is tricky to use
as this component and all of its children need to have their X/Y position not reliant on any parental width/height.

Expand Down

0 comments on commit 67ca997

Please sign in to comment.