Skip to content

Commit

Permalink
api documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidVollmers committed Apr 27, 2024
1 parent 07331fc commit 5fe2e3f
Show file tree
Hide file tree
Showing 1,303 changed files with 41,630 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaCheckGroup Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**A group of checkable elements.**

```csharp
public interface IAriaCheckGroup : Ignis.Components.HeadlessUI.Aria.IAriaComponent, Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider, Ignis.Components.HeadlessUI.Aria.IAriaLabeled
```

Implements: [IAriaComponent](Ignis.Components.HeadlessUI.Aria.IAriaComponent.md), [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md), [IAriaLabeled](Ignis.Components.HeadlessUI.Aria.IAriaLabeled.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaCheckGroupOption Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**A checkable element in a [IAriaCheckGroup](Ignis.Components.HeadlessUI.Aria.IAriaCheckGroup.md) .**

```csharp
public interface IAriaCheckGroupOption : Ignis.Components.HeadlessUI.Aria.IAriaLabeled, Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider, Ignis.Components.HeadlessUI.Aria.IAriaDescribed, Ignis.Components.Web.IFocus
```

Implements: [IAriaLabeled](Ignis.Components.HeadlessUI.Aria.IAriaLabeled.md), [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md), [IAriaDescribed](Ignis.Components.HeadlessUI.Aria.IAriaDescribed.md), [IFocus](../../Ignis.Components.Web/Ignis.Components.Web/Ignis.Components.Web.IFocus.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaComponent Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**An ARIA conform component.**

```csharp
public interface IAriaComponent : Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider
```

Implements: [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md)

## Methods

| | Summary |
| ---------------------------------------------------------- | -------------------------------- |
| GetId(Ignis.Components.HeadlessUI.Aria.IAriaComponentPart) | Gets the id of a component part. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaComponentPart Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**A part of an ARIA conform component.**

```csharp
public interface IAriaComponentPart : Ignis.Components.IElementReferenceProvider
```

Implements: [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md)

## Properties

| | Summary |
| --- | ----------------------------- |
| Id | The id of the component part. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaControl Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**A ARIA conform component that controls another component part.**

```csharp
public interface IAriaControl : Ignis.Components.HeadlessUI.Aria.IAriaComponent, Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider
```

Implements: [IAriaComponent](Ignis.Components.HeadlessUI.Aria.IAriaComponent.md), [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md)

## Properties

| | Summary |
| ---------- | -------------------------------------------------------- |
| Controlled | The component part that is controlled by this component. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaDescendant Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**A component part which is a descendant of an ARIA conform component.**

```csharp
public interface IAriaDescendant : Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider
```

Implements: [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md)

## Properties

| | Summary |
| -------- | --------------------------------------------------- |
| IsActive | Whether the component part is an active descendant. |

## Methods

| | Summary |
| ------- | --------------------------------------- |
| Click() | Whether the component part is disabled. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaDescribed Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**A component part that has a description.**

```csharp
public interface IAriaDescribed : Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider
```

Implements: [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md)

## Properties

| | Summary |
| ----------- | -------------------------------------- |
| Description | The description of the component part. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaLabeled Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**A component part that has a label.**

```csharp
public interface IAriaLabeled : Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider
```

Implements: [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md)

## Properties

| | Summary |
| ----- | -------------------------------- |
| Label | The label of the component part. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaModal Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**An ARIA conform modal.**

```csharp
public interface IAriaModal : Ignis.Components.HeadlessUI.Aria.IAriaComponent, Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider, Ignis.Components.HeadlessUI.Aria.IAriaLabeled, Ignis.Components.HeadlessUI.Aria.IAriaDescribed, Ignis.Components.HeadlessUI.IOpenClose
```

Implements: [IAriaComponent](Ignis.Components.HeadlessUI.Aria.IAriaComponent.md), [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md), [IAriaLabeled](Ignis.Components.HeadlessUI.Aria.IAriaLabeled.md), [IAriaDescribed](Ignis.Components.HeadlessUI.Aria.IAriaDescribed.md), [IOpenClose](../Ignis.Components.HeadlessUI/Ignis.Components.HeadlessUI.IOpenClose.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaPopup Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**An ARIA conform popup.**

```csharp
public interface IAriaPopup : Ignis.Components.HeadlessUI.Aria.IAriaControl, Ignis.Components.HeadlessUI.Aria.IAriaComponent, Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider, Ignis.Components.HeadlessUI.Aria.IAriaLabeled, Ignis.Components.HeadlessUI.IOpenClose, Ignis.Components.HeadlessUI.IWithTransition, Ignis.Components.Web.IFocus
```

Implements: [IAriaControl](Ignis.Components.HeadlessUI.Aria.IAriaControl.md), [IAriaComponent](Ignis.Components.HeadlessUI.Aria.IAriaComponent.md), [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md), [IAriaLabeled](Ignis.Components.HeadlessUI.Aria.IAriaLabeled.md), [IOpenClose](../Ignis.Components.HeadlessUI/Ignis.Components.HeadlessUI.IOpenClose.md), [IWithTransition](../Ignis.Components.HeadlessUI/Ignis.Components.HeadlessUI.IWithTransition.md), [IFocus](../../Ignis.Components.Web/Ignis.Components.Web/Ignis.Components.Web.IFocus.md)

## Properties

| | Summary |
| ---------------- | --------------------------------------- |
| Descendants | The descendants of the component. |
| ActiveDescendant | The active descendant of the component. |
| Button | The button which controls the popup. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI.Aria](README.md) /

# IAriaPopup<T> Interface

## Definition

Namespace: [Ignis.Components.HeadlessUI.Aria](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**An ARIA conform popup.**

```csharp
public interface IAriaPopup<T> : Ignis.Components.HeadlessUI.Aria.IAriaPopup, Ignis.Components.HeadlessUI.Aria.IAriaControl, Ignis.Components.HeadlessUI.Aria.IAriaComponent, Ignis.Components.HeadlessUI.Aria.IAriaComponentPart, Ignis.Components.IElementReferenceProvider, Ignis.Components.HeadlessUI.Aria.IAriaLabeled, Ignis.Components.HeadlessUI.IOpenClose, Ignis.Components.HeadlessUI.IWithTransition, Ignis.Components.Web.IFocus
```

Implements: [IAriaPopup](Ignis.Components.HeadlessUI.Aria.IAriaPopup.md), [IAriaControl](Ignis.Components.HeadlessUI.Aria.IAriaControl.md), [IAriaComponent](Ignis.Components.HeadlessUI.Aria.IAriaComponent.md), [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md), [IElementReferenceProvider](../../Ignis.Components/Ignis.Components/Ignis.Components.IElementReferenceProvider.md), [IAriaLabeled](Ignis.Components.HeadlessUI.Aria.IAriaLabeled.md), [IOpenClose](../Ignis.Components.HeadlessUI/Ignis.Components.HeadlessUI.IOpenClose.md), [IWithTransition](../Ignis.Components.HeadlessUI/Ignis.Components.HeadlessUI.IWithTransition.md), [IFocus](../../Ignis.Components.Web/Ignis.Components.Web/Ignis.Components.Web.IFocus.md)

## Type Parameters

- `T`

The type of popup descendants.

## Properties

| | Summary |
| ---------------- | ------- |
| Descendants | |
| ActiveDescendant | |

## Methods

| | Summary |
| ------------------- | ---------------------------------------- |
| AddDescendant(T) | Adds a descendant to the component. |
| RemoveDescendant(T) | Removes a descendant from the component. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Ignis.Components.HeadlessUI.Aria Namespace

## Types

- [IAriaCheckGroup](Ignis.Components.HeadlessUI.Aria.IAriaCheckGroup.md)
- [IAriaCheckGroupOption](Ignis.Components.HeadlessUI.Aria.IAriaCheckGroupOption.md)
- [IAriaComponent](Ignis.Components.HeadlessUI.Aria.IAriaComponent.md)
- [IAriaComponentPart](Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md)
- [IAriaControl](Ignis.Components.HeadlessUI.Aria.IAriaControl.md)
- [IAriaDescendant](Ignis.Components.HeadlessUI.Aria.IAriaDescendant.md)
- [IAriaDescribed](Ignis.Components.HeadlessUI.Aria.IAriaDescribed.md)
- [IAriaLabeled](Ignis.Components.HeadlessUI.Aria.IAriaLabeled.md)
- [IAriaModal](Ignis.Components.HeadlessUI.Aria.IAriaModal.md)
- [IAriaPopup&lt;T&gt;](Ignis.Components.HeadlessUI.Aria.IAriaPopup_1.md)
- [IAriaPopup](Ignis.Components.HeadlessUI.Aria.IAriaPopup.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
[Packages](../../README.md) / [Ignis.Components.HeadlessUI](../README.md) / [Ignis.Components.HeadlessUI](README.md) /

# DialogDescription Class

## Definition

Namespace: [Ignis.Components.HeadlessUI](README.md)

Assembly: [Ignis.Components.HeadlessUI.dll](../README.md)

Package: [Ignis.Components.HeadlessUI](https://www.nuget.org/packages/Ignis.Components.HeadlessUI)

---

**The description of a dialog.**

```csharp
public sealed class DialogDescription : Ignis.Components.DynamicComponentBase<Ignis.Components.HeadlessUI.DialogDescription>, Ignis.Components.HeadlessUI.Aria.IAriaComponentPart
```

Inheritance: [System.Object](https://learn.microsoft.com/en-us/dotnet/api/System.Object) → [IgnisComponentBase](../../Ignis.Components/Ignis.Components/Ignis.Components.IgnisComponentBase.md) → [DynamicComponentBase](../../Ignis.Components/Ignis.Components/Ignis.Components.DynamicComponentBase_1.md)&lt;[DialogDescription](Ignis.Components.HeadlessUI.DialogDescription.md)&gt; → DialogDescription

Implements: [IAriaComponentPart](../Ignis.Components.HeadlessUI.Aria/Ignis.Components.HeadlessUI.Aria.IAriaComponentPart.md)

## Constructors

| | Summary |
| ------------------- | -------------------------------------------------------------------------------------------------------------- |
| DialogDescription() | Initializes a new instance of the [DialogDescription](Ignis.Components.HeadlessUI.DialogDescription.md) class. |

## Properties

| | Summary |
| ------------ | ------- |
| Id | |
| Dialog | |
| ChildContent | |

## Methods

| | Summary |
| ---------------------------------------------------------------------------- | ------- |
| OnInitialized() | |
| BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder) | |
Loading

0 comments on commit 5fe2e3f

Please sign in to comment.