Skip to content

Commit 2f8d9a7

Browse files
committed
Sorted API documentation
1 parent 76fffe3 commit 2f8d9a7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+3949
-0
lines changed

.github/workflows/docs.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- src/**
9+
- docs/**
10+
- .github/workflows/docs.yml
11+
pull_request:
12+
branches:
13+
- main
14+
paths:
15+
- docs/**
16+
- .github/workflows/docs.yml
17+
workflow_dispatch:
18+
19+
jobs:
20+
generate-docs:
21+
22+
runs-on: windows-latest
23+
24+
steps:
25+
- uses: actions/checkout@v2
26+
27+
- name: Setup .NET 5.0
28+
uses: actions/setup-dotnet@v1
29+
with:
30+
dotnet-version: 5.0.x
31+
32+
- name: Setup .NET 6.0
33+
uses: actions/setup-dotnet@v1
34+
with:
35+
dotnet-version: 6.0.x
36+
37+
- name: Setup DocFX
38+
uses: crazy-max/ghaction-chocolatey@v1
39+
with:
40+
args: install docfx
41+
42+
- name: DocFX Build
43+
working-directory: docs
44+
run: docfx .\docfx.json
45+
continue-on-error: false
46+
47+
- name: Publish
48+
if: github.event_name == 'push'
49+
uses: peaceiris/actions-gh-pages@v3
50+
with:
51+
github_token: ${{ secrets.GITHUB_TOKEN }}
52+
publish_dir: docs/_site
53+
force_orphan: true

.vscode/extensions.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"recommendations": [
3+
]
4+
}

.vscode/launch.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "Run: Docs",
9+
"preLaunchTask": "npm_install_docs",
10+
"cwd": "${workspaceFolder}/docs",
11+
"command": "npm run docfx",
12+
"request": "launch",
13+
"type": "node-terminal"
14+
}
15+
],
16+
"compounds": []
17+
}

.vscode/settings.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
{
2+
}

.vscode/tasks.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "npm_install_docs",
6+
"type": "npm",
7+
"script": "install",
8+
"path": "docs/",
9+
"problemMatcher": [],
10+
}
11+
]
12+
}

docs/.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
###############
2+
# folder #
3+
###############
4+
/**/DROP/
5+
/**/TEMP/
6+
/**/packages/
7+
/**/bin/
8+
/**/obj/
9+
_site

docs/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# MADE Uno Documentation
2+
3+
This folder contains source code for the generation of MADE Uno's documentation.
4+
5+
## Contributing to the docs
6+
7+
### Install dependencies
8+
9+
Download and install docfx on your computer.
10+
11+
#### MacOS
12+
13+
```
14+
brew install docfx
15+
```
16+
17+
#### Windows
18+
19+
```
20+
choco install docfx
21+
```
22+
23+
### Running locally
24+
25+
```
26+
docfx .\docfx.json --serve
27+
```
28+
29+
This will run the docs on `http://localhost:8080`

docs/api/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
###############
2+
# temp file #
3+
###############
4+
*.yml
5+
.manifest

docs/api/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
uid: api-docs
3+
title: Explore the APIs
4+
---
5+
6+
# Explore the APIs
7+
8+
Here you'll find all of the generated code documentation for the MADE Uno projects, similar to what you might find on Microsoft Docs!
9+
10+
This documentation is designed to show you how each component of MADE Uno is constructed and provide a reference for you when building your projects.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
uid: package-ui-controls-dropdownlist
3+
title: Using the DropDownList control
4+
---
5+
6+
# Using the DropDownList control
7+
8+
The `MADE.UI.Controls.DropDownList` element is a custom-built UI element for Windows (UWP) applications that provides a selection user experience, allowing a user to select one or multiple items from a list.
9+
10+
The control works in a similar way to the `ComboBox` element in the Windows SDK, with the added extensibility to change modes to select multiple items.
11+
12+
Shown below is the visuals for the control in its default state, in a multiple selection mode.
13+
14+
<img src="../../images/MultiSelectDropDownListCollapsed.png" alt="DropDownList control showing multiple selected items" />
15+
16+
<img src="../../images/MultiSelectDropDownListExpanded.png" alt="DropDownList control showing expanded selection with selected items" />
17+
18+
## Example usage
19+
20+
```xml
21+
<Page
22+
x:Class="DropDownListSample.MainPage"
23+
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
24+
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
25+
xmlns:controls="using:MADE.UI.Controls"
26+
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
27+
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
28+
Background="{ThemeResource ApplicationPageBackgroundThemeBrush}"
29+
mc:Ignorable="d">
30+
31+
<RelativePanel Padding="12">
32+
<controls:DropDownList
33+
x:Name="DropDownList"
34+
Header="MultiDropDownList"
35+
ItemsSource="{x:Bind ViewModel.ItemCollection}"
36+
RelativePanel.AlignLeftWithPanel="True"
37+
RelativePanel.AlignRightWithPanel="True"
38+
RelativePanel.AlignTopWithPanel="True"
39+
SelectionMode="Multiple" />
40+
</RelativePanel>
41+
</Page>
42+
```
43+
44+
## Customizing the DropDownList
45+
46+
The control has many customization properties that are exposed to tailor the experience for your application.
47+
48+
### HeaderTemplate
49+
50+
The `Header` can be customized to include custom UI elements as well as a string resource.
51+
52+
The `HeaderTemplate` is also available to provide a `DataTemplate` for you to define the rendered UI for the `Header`.
53+
54+
### ItemTemplate and ItemTemplateSelector
55+
56+
The rendered UI elements for the items in the control can be customized with the `ItemTemplate` or `ItemTemplateSelector`.
57+
58+
### SelectionMode
59+
60+
The `DropDownList` has two selection modes, `Single` and `Multiple`.
61+
62+
By default, the control works in a `Single` selection mode.
63+
64+
### MaxDropDownHeight
65+
66+
The height of the drop-down can be customized to allow you to show more results that the default expanded view.
67+
68+
By default, the drop down will expand to 248 pixels.

0 commit comments

Comments
 (0)