Update Markdown files
Fix-up MarkdownLint warnings
This commit is contained in:
Nirmal Guru
Родитель
bc09868947
Коммит
43cf51f3ac
|
|
@ -8,7 +8,7 @@ assignees: ''
|
|||
|
||||
<!-- 🚨 PLEASE DO NOT SKIP ANY INSTRUCTIONS AND INFORMATION MENTIONED BELOW AS THEY ARE ALL REQUIRED AND ESSENTIAL TO INVESTIGATE THE ISSUE. ISSUES WITH MISSING INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION
|
||||
...
|
||||
IF NOT CERTAIN ABOUT THE ISSUE AND REQUIRE MORE CLARITY THEN PLEASE POST ON "QUESTIONS & HELP" CATEGORY OF THE DISCUSSIONS PLATFORM [https://github.com/CommunityToolkit/WindowsCommunityToolkit/discussions/categories/questions-help] WHERE YOU CAN DISCUSS AND ENAGAGE WITH THE COMMUNITY TO GAIN FURTHER CLAIRITY REGARDING THE ISSUE 🚨 -->
|
||||
IF NOT CERTAIN ABOUT THE ISSUE AND REQUIRE MORE CLARITY THEN PLEASE POST ON "QUESTIONS & HELP" CATEGORY OF THE DISCUSSIONS PLATFORM [https://github.com/CommunityToolkit/WindowsCommunityToolkit/discussions/categories/questions-help] WHERE YOU CAN DISCUSS AND ENGAGE WITH THE COMMUNITY TO GAIN FURTHER CLARITY REGARDING THE ISSUE 🚨 -->
|
||||
|
||||
## Describe the bug
|
||||
|
||||
|
|
@ -42,9 +42,9 @@ Steps to reproduce the behavior:
|
|||
|
||||
## Environment
|
||||
|
||||
<!-- Check one or more of the following options with "x" -->
|
||||
<!-- Check one or more of the following options with "x" and replace the {build_number} and {minor_version} with the actual values -->
|
||||
|
||||
NuGet Package(s):
|
||||
NuGet Package(s): <!-- Which NuGet Packages have you used -->
|
||||
|
||||
Package Version(s):
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ Windows 10 Build Number:
|
|||
- [ ] October 2018 Update (17763)
|
||||
- [ ] May 2019 Update (18362)
|
||||
- [ ] May 2020 Update (19041)
|
||||
- [ ] Insider Build (build number: )
|
||||
- [ ] Insider Build ({build_number})
|
||||
|
||||
App min and target version:
|
||||
|
||||
|
|
@ -64,7 +64,7 @@ App min and target version:
|
|||
- [ ] October 2018 Update (17763)
|
||||
- [ ] May 2019 Update (18362)
|
||||
- [ ] May 2020 Update (19041)
|
||||
- [ ] Insider Build (xxxxx)
|
||||
- [ ] Insider Build ({build_number})
|
||||
|
||||
Device form factor:
|
||||
|
||||
|
|
@ -73,11 +73,11 @@ Device form factor:
|
|||
- [ ] Surface Hub
|
||||
- [ ] IoT
|
||||
|
||||
Visual Studio
|
||||
Visual Studio version:
|
||||
|
||||
- [ ] 2017 (version: )
|
||||
- [ ] 2019 (version: )
|
||||
- [ ] 2019 Preview (version: )
|
||||
- [ ] 2017 (15.{minor_version})
|
||||
- [ ] 2019 (16.{minor_version})
|
||||
- [ ] 2022 (17.{minor_version})
|
||||
|
||||
## Additional context
|
||||
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@
|
|||
|
||||
<!-- 📝 Please always keep the "☑️ Allow edits by maintainers" button checked in the Pull Request Template as it increases collaboration with the Toolkit maintainers by permitting commits to your PR branch (only) created from your fork. This can let us quickly make fixes for minor typos or forgotten StyleCop issues during review without needing to wait on you doing extra work. Let us help you help us! 🎉 -->
|
||||
|
||||
## Fixes #
|
||||
## Fixes
|
||||
|
||||
<!-- Add the relevant issue number after the "#" mentioned above (for ex: "## Fixes #1234") which will automatically close the issue once the PR is merged. -->
|
||||
<!-- Add the relevant issue number after the word "Fixes" mentioned above (for ex: "## Fixes #1234") which will automatically close the issue once the PR is merged. -->
|
||||
|
||||
<!-- Add a brief overview here of the feature/bug & fix. -->
|
||||
|
||||
|
|
@ -35,10 +35,10 @@ What kind of change does this PR introduce?
|
|||
|
||||
## PR Checklist
|
||||
|
||||
Please check if your PR fulfills the following requirements:
|
||||
Please check if your PR fulfills the following requirements: <!-- and remove the ones that are not applicable to the current PR -->
|
||||
|
||||
- [ ] Tested code with current [supported SDKs](../readme.md#supported)
|
||||
- [ ] Pull Request has been submitted to the documentation repository [instructions](..\contributing.md#docs). Link: <!-- docs PR link -->
|
||||
- [ ] Tested code with current [supported SDKs](../#supported)
|
||||
- [ ] Pull Request has been submitted to the documentation repository [instructions](../blob/main/Contributing.md#docs). Link: <!-- docs PR link -->
|
||||
- [ ] Sample in sample app has been added / updated (for bug fixes / features)
|
||||
- [ ] Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/CommunityToolkit/WindowsCommunityToolkit-design-assets)
|
||||
- [ ] New major technical changes in the toolkit have or will be added to the [Wiki](https://github.com/CommunityToolkit/WindowsCommunityToolkit/wiki) e.g. build changes, source generators, testing infrastructure, sample creation changes, etc...
|
||||
|
|
@ -50,3 +50,5 @@ Please check if your PR fulfills the following requirements:
|
|||
Please note that breaking changes are likely to be rejected within minor release cycles or held until major versions. -->
|
||||
|
||||
## Other information
|
||||
|
||||
<!-- Please add any other information that might be helpful to reviewers. -->
|
||||
|
|
@ -68,9 +68,9 @@ members of the project's leadership.
|
|||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see
|
||||
https://www.contributor-covenant.org/faq
|
||||
<https://www.contributor-covenant.org/faq>
|
||||
|
|
|
|||
|
|
@ -1,46 +1,46 @@
|
|||
# Contributing to the Windows Community Toolkit :sparkles::sparkles:
|
||||
# ✨ Contributing to the Windows Community Toolkit
|
||||
|
||||
Thank you for exhibiting interest in contributing to the Windows Community Toolkit. The team is delighted to welcome you onboard to our exciting and growing project. Any contribution or value added go a long way to enhance the project!
|
||||
|
||||
In the next few steps, you will be able to see a glimpse of ways you can contribute to the Windows Community Toolkit.
|
||||
|
||||
:rotating_light: **It is highly recommended to visit [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) where you can find complete and detail-oriented content of this page** :rotating_light:
|
||||
🚨 **It is highly recommended to visit [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) where you can find complete and detail-oriented content of this page** 🚨
|
||||
|
||||
## <a name="question"></a> Questions :grey_question:
|
||||
## ❔ Questions <a name="question"></a>
|
||||
|
||||
Due to the high volume of incoming issues please keep our GitHub issues for bug reports and feature requests. For general questions, there is a higher chance of getting your question answered on [StackOverflow](https://stackoverflow.com/questions/tagged/windows-community-toolkit) where questions should be tagged with the tag windows-community-toolkit.
|
||||
Due to the high volume of incoming issues please keep our GitHub issues for bug reports and feature requests. For general questions, there is a higher chance of getting your question answered on [StackOverflow](https://stackoverflow.com/questions/tagged/windows-community-toolkit) where questions should be tagged with the tag `windows-community-toolkit`.
|
||||
|
||||
For missing documentation related question, please file an issue at [Microsoft Docs](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/issues/new).
|
||||
|
||||
## <a name="bug"></a> Fix a Bug :bug:
|
||||
## 🐛 Fix a Bug <a name="bug"></a>
|
||||
|
||||
If you find any bug, you can help the community by [submitting an issue](https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/new?assignees=&labels=bug+%3Abug%3A&template=bug_report.md&title=). Once the issue is filed, feel free to start working on the PR and submit a PR.
|
||||
If you find any bug, you can help the community by [submitting an issue](https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/new?template=bug_report.md&labels=bug+:bug:&title=[Bug]). Once the issue is filed, feel free to start working on the PR and submit a PR.
|
||||
|
||||
## <a name="issue"></a>Good First Issue :ok_hand:
|
||||
## 👌 Good First Issue <a name="issue"></a>
|
||||
|
||||
If this is your first time contributing to the Windows Community Toolkit and do not have advanced level programming experience, we have got you covered :boom: WCT has a list of [good first issue](https://github.com/CommunityToolkit/WindowsCommunityToolkit/labels/good%20first%20issue%20%3Aok_hand%3A) that can be a great entryway to find and fix any issues that best fit your expertise or technical background.
|
||||
If this is your first time contributing to the Windows Community Toolkit (_WCT_) and do not have advanced level programming experience, we have got you covered 💥 WCT has a list of [good first issue](https://github.com/CommunityToolkit/WindowsCommunityToolkit/labels/good%20first%20issue) that can be a great entryway to find and fix any issues that best fit your expertise or technical background.
|
||||
|
||||
## <a name="help"></a>Help Wanted :raising_hand:
|
||||
## 🙋 Help Wanted <a name="help"></a>
|
||||
|
||||
WCT has a list of issues that are labeled as [help wanted](https://github.com/CommunityToolkit/WindowsCommunityToolkit/labels/help%20wanted%20%3Araising_hand%3A). The level of complexity in the list can vary but if you have an advanced level of programming experience, feel free to jump in to solve these issues.
|
||||
WCT also has a list of issues that are labeled as [help wanted](https://github.com/CommunityToolkit/WindowsCommunityToolkit/labels/help%20wanted). The level of complexity in the list can vary but if you have an advanced level of programming experience, feel free to jump in to solve these issues.
|
||||
|
||||
## <a name="feature"></a>Add New Feature :mailbox_with_mail:
|
||||
## 📬 Add New Feature <a name="feature"></a>
|
||||
|
||||
* To contribute a new feature, fill out the [Feature Request Template](https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/new?assignees=&labels=feature+request+%3Amailbox_with_mail%3A&template=feature_request.md&title=%5BFeature%5D) and provide detailed information to express the proposal.
|
||||
* To contribute a new feature, fill out the [Feature Request Template](https://github.com/CommunityToolkit/WindowsCommunityToolkit/issues/new?template=feature_request.md&labels=feature+request+:mailbox_with_mail:&title=[Feature]) and provide detailed information to express the proposal.
|
||||
* Once the Feature Request is submitted, it will be open for discussion.
|
||||
* If it gets approved by the team, proceed to submit a PR of the proposed Feature.
|
||||
* If the PR contains an error-free code and the reviewer signs off, the PR will be merged.
|
||||
|
||||
## <a name="docs"></a> Add or Improve Documentation :page_with_curl:
|
||||
## 📝 Add or Improve Documentation <a name="docs"></a>
|
||||
|
||||
Due to the involvement of multiple steps to add or improve documents; it is required to visit [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) and follow contribution guidelines.
|
||||
|
||||
## <a name="pr"></a>Create, Submit or Review Pull Request :rocket:
|
||||
## 🚀 Create, Submit or Review Pull Request <a name="pr"></a>
|
||||
|
||||
Anyone with write access can create a Pull Request by forking the Windows Community Toolkit Repository. Here is how you can [Create a Pull Request from fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Once you fork the Windows Community Toolkit repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main Windows Community Toolkit.
|
||||
Anyone can create a Pull Request by forking the Windows Community Toolkit Repository. Here is how you can [Create a Pull Request from fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Once you fork the Windows Community Toolkit repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main Windows Community Toolkit.
|
||||
|
||||
Please visit [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) for detailed information and steps it requires to Submit or Review Pull Request.
|
||||
|
||||
# ThankYou :heart::heart:
|
||||
## 💙 Thank You
|
||||
|
||||
**Thank you so much for contributing to this amazing project. We hope you will continue to add value and find yourself as a highly reliable source to the Windows Community Toolkit**
|
||||
**Thank you so much for contributing to this amazing project. We hope you will continue to add value and find yourself as a highly reliable source to the Windows Community Toolkit.**
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
# Windows Community Toolkit
|
||||
|
||||
Copyright (c) .NET Foundation and Contributors
|
||||
Copyright © .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
# MIT License (MIT)
|
||||
## MIT License (MIT)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
|
|||
|
|
@ -1,105 +1,110 @@
|
|||
# Sample Application
|
||||
|
||||
For the latest info, [visit the wiki article here](https://github.com/CommunityToolkit/WindowsCommunityToolkit/wiki/Sample-Development).
|
||||
|
||||
# How to add new samples
|
||||
## How to add new samples
|
||||
|
||||
This document describes how to add a new sample page for a new control you want to add to the toolkit.
|
||||
|
||||
*DropShadowPanel*, *ImageEx*, and *ImageCache* are good examples of most of the features mentioned below.
|
||||
*`DropShadowPanel`*, *`ImageEx`*, and *`ImageCache`* are good examples of most of the features mentioned below.
|
||||
|
||||
### 1. Add Sample page and `.bind` template
|
||||
|
||||
## 1. Add Sample page and .bind template
|
||||
First you need to create a XAML page in the folder `/SamplePages/YourControl`. This will be the logical page used to by the app to navigate to the sample and contains code.
|
||||
|
||||
First you need to create a Xaml page in the folder /SamplePages/YourControl. This will be the logical page used to by the app to navigate to the sample and contains code.
|
||||
|
||||
If providing 'live' XAML, a .bind file is loaded and dynamically fed to the XamlReader.Load method to convert into actual controls. This changes a few things about how samples need to be written (detailed below), but allows developers to actually change the sample and see the results live.
|
||||
If providing 'live' XAML, a `.bind` file is loaded and dynamically fed to the `XamlReader.Load` method to convert into actual controls. This changes a few things about how samples need to be written (detailed below), but allows developers to actually change the sample and see the results live.
|
||||
|
||||
This not only gives us a killer sample app, but it also means that all our samples are also self-validating. There can't be a typo in the sample text given in the sample app anymore, as otherwise the sample won't work and should be caught during testing of said sample.
|
||||
|
||||
### 2. Binding text
|
||||
|
||||
## 2. Binding text
|
||||
|
||||
The .bind files are templates which use @[Property Name:Type:DefaultValue:Options] syntax to allow for customized options to be presented to the user in the sample app. The user can play with the values in the property page and see results change instantly. This is accomplished by using {Binding} syntax when on the property page, but switches to the raw value when the developer goes to the XAML page.
|
||||
The `.bind` files are templates which use `@[Property Name:Type:DefaultValue:Options]` syntax to allow for customized options to be presented to the user in the sample app. The user can play with the values in the property page and see results change instantly. This is accomplished by using {Binding} syntax when on the property page, but switches to the raw value when the developer goes to the XAML page.
|
||||
|
||||
This makes it easy for a developer to test out values for a control and then copy the XAML needed for that exact result into their app.
|
||||
|
||||
In order to provide a property UI and associated code, you have to define a the .bind XAML file associated with your page.
|
||||
In order to provide a property UI and associated code, you have to define a `.bind` XAML file associated with your page.
|
||||
Here is an example:
|
||||
|
||||
```xaml
|
||||
```xml
|
||||
<Grid>
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition Width="48"></ColumnDefinition>
|
||||
<ColumnDefinition></ColumnDefinition>
|
||||
<ColumnDefinition Width="48" />
|
||||
<ColumnDefinition />
|
||||
</Grid.ColumnDefinitions>
|
||||
<TextBlock Grid.Column="1"
|
||||
Text="@[Text:String:Hey!]" Foreground="Black"
|
||||
Foreground="Black"
|
||||
Text="@[Text:String:Hey!]"
|
||||
FontSize="@[FontSize:Slider:12:10-30]"
|
||||
VerticalAlignment="@[Vertical Alignment:Enum:VerticalAlignment.Center]">
|
||||
</TextBlock>
|
||||
</Grid>
|
||||
```
|
||||
|
||||
You can define "interactive" values in this file. The value types can be:
|
||||
* String: You want the user to provide a text. The string is built like this @[Name:**String**:Default value]
|
||||
* Slider: You want the user to provide a double value. The string is built like this @[Name:**Slider**:Default value:min-max]
|
||||
* DoubleSlider: Same as slider but with double values (0.01 precision)
|
||||
* TimeSpan: You want the user to provide a duration. The string is built like this (all values in milliseconds) @[Name:**TimeSpan**:DefaultValue:min-max]
|
||||
* Enum: You want the user to provide a enum value. The string is built like this @[Name:**Enum**:EnumType.DefaultValue]
|
||||
* Brush: You want the user to select a color from a list. The string is built like this @[Name:**Brush**:Black]
|
||||
* Bool: You want the user to enable or disable a property. The string is built like this @[Name:**Bool**:True]
|
||||
* Thickness: You want the user to provide a Thickness. The string is built like this @[Name:**Thickness**:0,20,10,0]
|
||||
You can define “interactive” values in this file. The value types can be:
|
||||
|
||||
* `String`: You want the user to provide a text. An equivalent syntax is `@[Name:String:Default Value]`
|
||||
* `Slider`: You want the user to provide a double value. An equivalent syntax is `@[Name:Slider:DefaultValue:Min-Max]`
|
||||
* `DoubleSlider`: Same as slider but with double values (0.01 precision)
|
||||
* `TimeSpan`: You want the user to provide a duration. An equivalent syntax is (all values in milliseconds) `@[Name:TimeSpan:DefaultValue:Min-Max]`
|
||||
* `Enum`: You want the user to provide an enum value. An equivalent syntax is `@[Name:Enum:EnumType.DefaultValue]`
|
||||
* `Brush`: You want the user to select a color from a list. An equivalent syntax is `@[Name:Brush:Black]`
|
||||
* `Bool`: You want the user to enable or disable a property. An equivalent syntax is `@[Name:Bool:True]`
|
||||
* `Thickness`: You want the user to provide a Thickness. An equivalent syntax is `@[Name:Thickness:0,20,10,0]`
|
||||
|
||||
The `Property Name` can also contain spaces, but these will be removed from the property name used for accessing the value in the property bag for any binding/access, see below.
|
||||
|
||||
The name and options will be translated **automatically** to the following syntax when your .bind template is being used on the property page:
|
||||
The name and options will be translated **automatically** to the following syntax when your `.bind` template is being used on the property page:
|
||||
|
||||
```xaml
|
||||
```xml
|
||||
<Grid Margin="10">
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition Width="48"></ColumnDefinition>
|
||||
<ColumnDefinition></ColumnDefinition>
|
||||
<ColumnDefinition Width="48" />
|
||||
<ColumnDefinition />
|
||||
</Grid.ColumnDefinitions>
|
||||
<TextBlock Grid.Column="1" Text="{Binding Text.Value, Mode=OneWay}" Foreground="Black"
|
||||
FontSize="{Binding FontSize.Value, Mode=OneWay}"
|
||||
VerticalAlignment="{Binding VerticalAlignment.Value, Mode=OneWay}"></TextBlock>
|
||||
<TextBlock Grid.Column="1" Foreground="Black"
|
||||
Text="{Binding Text.Value, Mode=OneWay}"
|
||||
FontSize="{Binding FontSize.Value, Mode=OneWay}"
|
||||
VerticalAlignment="{Binding VerticalAlignment.Value, Mode=OneWay}">
|
||||
</TextBlock>
|
||||
</Grid>
|
||||
```
|
||||
|
||||
When the developer switches to the XAML tab, they'll automatically see the selected values instead:
|
||||
|
||||
```xaml
|
||||
```xml
|
||||
<Grid Margin="10">
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition Width="48"></ColumnDefinition>
|
||||
<ColumnDefinition></ColumnDefinition>
|
||||
<ColumnDefinition Width="48" />
|
||||
<ColumnDefinition />
|
||||
</Grid.ColumnDefinitions>
|
||||
<TextBlock Grid.Column="1" Text="User Entered Text" Foreground="Black"
|
||||
FontSize="12"
|
||||
VerticalAlignment="Left"></TextBlock>
|
||||
<TextBlock Grid.Column="1"
|
||||
Foreground="Black"
|
||||
Text="User Entered Text"
|
||||
FontSize="12"
|
||||
VerticalAlignment="Left">
|
||||
</TextBlock>
|
||||
</Grid>
|
||||
```
|
||||
|
||||
You can also reuse a `@[Property Name]` reference by itself again later to use the same binding/value again in the same template. This will automatically get mapped to the right place without the need to specify all the types/options again. Just set those options on your first usage.
|
||||
|
||||
If you happen to need a two-way binding for the generated XAML, then add an extra '@' after the property definition in the template:
|
||||
If you happen to need a two-way binding for the generated XAML, then add an extra '**@**' after the property definition in the template:
|
||||
|
||||
```xaml
|
||||
Value="@[Value:Slider:0:0-180]@"
|
||||
```xml
|
||||
<Slider Value="@[Value:Slider:0:0-180]@" />
|
||||
```
|
||||
|
||||
## 3. Have a *'Shallow Copy'* of your example in the sample page
|
||||
### 3. Have a '*Shallow Copy*' of your example in the sample page
|
||||
|
||||
Even though the sample page content is ignored and the dynamic template injected, for the XamlReader to access some classes, a reference to the item is sometimes needed in the hosting app for it to be accessible. (I assume it's an optimization thing.)
|
||||
Even though the sample page content is ignored and the dynamic template injected, for the `XamlReader` to access some classes, a reference to the item is sometimes needed in the hosting app for it to be accessible. (I assume it's an optimization thing.)
|
||||
|
||||
Therefore, for any new control/extension, you should still have a simplified snippet of it contained in the sample page compiled/loaded by the app. You should remove names, events, and properties (unless extensions) from these so the namespace isn't accidentally polluted. If you re-use the same control, you don't have to include it twice.
|
||||
Therefore, for any new control/extension, you should still have a simplified snippet of it contained in the sample page compiled/loaded by the app. You should remove names, events, and properties (unless extensions) from these, so the namespace isn't accidentally polluted. If you re-use the same control, you don't have to include it twice.
|
||||
|
||||
### 4. For Events/Resource Templates: Have your sample page implement the **`IXamlRendererListener`** interface
|
||||
|
||||
## 4. For Events/Resource Templates: Have your sample page implement the **IXamlRendererListener** interface
|
||||
This gets called whenever the template gets parsed (due to loading or user modification). Here you can use the [`LogicalTree`](https://github.com/CommunityToolkit/WindowsCommunityToolkit/blob/main/Microsoft.Toolkit.Uwp.UI/Extensions/FrameworkElement/FrameworkElementExtensions.LogicalTree.cs) extensions to grab named controls in the template and register their events. **Check for null first** as the developer may have removed the name from the element.
|
||||
|
||||
This gets called whenever the template gets parsed (due to loading or user modification). Here you can use the [LogicalTree](https://github.com/CommunityToolkit/WindowsCommunityToolkit/blob/main/Microsoft.Toolkit.Uwp.UI/Extensions/Tree/LogicalTree.cs) extensions to grab named controls in the template and register their events. **Check for null first** as the developer may have removed the name from the element.
|
||||
|
||||
```csharp
|
||||
```cs
|
||||
var markdownText = control.FindChild("MarkdownText") as MarkdownTextBlock;
|
||||
if (markdownText != null)
|
||||
{
|
||||
|
|
@ -107,14 +112,13 @@ if (markdownText != null)
|
|||
}
|
||||
```
|
||||
|
||||
You'll have to register all events and grab **control.Resources** for templates from this method as the regular sample page XAML isn't used and you can't hook in an event from the dynamic XAML, it must be done via code by finding the element here.
|
||||
You'll have to register all events and grab **`control.Resources`** for templates from this method as the regular sample page XAML isn't used, and you can't hook in an event from the dynamic XAML, it must be done via code by finding the element here.
|
||||
|
||||
### 5. For Interactive Buttons: Use **`SampleController.Current.RegisterNewCommand`**
|
||||
|
||||
## 5. For Interactive Buttons: Use **SampleController.Current.RegisterNewCommand**
|
||||
Buttons can be added through this command and are accessible in the main panel, so they can be clicked when changing properties or editing XAML. It's important instead of using buttons in your sample (as events can't be directly used, see above) to register these commands.
|
||||
|
||||
Buttons can be added through this command and are accessible in the main panel so they can be clicked when changing properties or editing XAML. It's important instead of using buttons in your sample (as events can't be directly used, see above) to register these commands.
|
||||
|
||||
```csharp
|
||||
```cs
|
||||
protected override async void OnNavigatedTo(NavigationEventArgs e)
|
||||
{
|
||||
base.OnNavigatedTo(e);
|
||||
|
|
@ -123,28 +127,30 @@ protected override async void OnNavigatedTo(NavigationEventArgs e)
|
|||
{
|
||||
AddImage(false, true);
|
||||
});
|
||||
|
||||
// •••
|
||||
}
|
||||
```
|
||||
|
||||
If your command adds content dynamically, try and use a style template in the .bind XAML that the user can modify. Then grab `resources = control.Resources;` in the *OnXamlRendered* event and set the element style from it:
|
||||
If your command adds content dynamically, try and use a style template in the `.bind` XAML that the user can modify. Then grab `resources = control.Resources;` in the *`OnXamlRendered`* event and set the element style from it:
|
||||
|
||||
```csharp
|
||||
```cs
|
||||
if (resources?.ContainsKey("ThingStyle") == true)
|
||||
{
|
||||
newThing.Style = resources["ThingStyle"] as Style;
|
||||
}
|
||||
```
|
||||
|
||||
## 6. *Optional:* If you need *extra stuff* around the sample
|
||||
### 6. *Optional:* If you need *extra stuff* around the sample
|
||||
|
||||
Now, the sample page content in the app is ignored, but you can override that behavior by adding a `<Grid x:Name="XamlRoot"/>` element to the page. If this element is found, it will serve as the host to the dynamic .bind content instead. In this manner you can have a status/warning message outside of the control of the developer in the XAML sample tab.
|
||||
Now, the sample page content in the app is ignored, but you can override that behavior by adding a `<Grid x:Name="XamlRoot"/>` element to the page. If this element is found, it will serve as the host to the dynamic `.bind` content instead. In this manner you can have a status/warning message outside the control of the developer in the XAML sample tab.
|
||||
|
||||
## Update `Samples.json`
|
||||
|
||||
# Update Samples.json
|
||||
|
||||
After creating your page and the binding text, you just need to reference it in the /SamplePages/samples.json file.
|
||||
After creating your page and the binding text, you just need to reference it in the `/SamplePages/samples.json` file.
|
||||
Select the category where you want your page to be listed and add the following information:
|
||||
|
||||
## Basic Structure
|
||||
### Basic Structure
|
||||
|
||||
```json
|
||||
[
|
||||
|
|
@ -156,7 +162,7 @@ Select the category where you want your page to be listed and add the following
|
|||
"Name": "AdaptiveGridView",
|
||||
"Type": "AdaptiveGridViewPage",
|
||||
"About": "The AdaptiveGridView control allows to present information within a Grid View perfectly adjusting the total display available space. It reacts to changes in the layout as well as the content so it can adapt to different form factors automatically. The number and the width of items are calculated based on the screen resolution in order to fully leverage the available screen space. The property ItemsHeight define the items fixed height and the property DesiredWidth sets the minimum width for the elements to add a new column.",
|
||||
"CodeUrl": "https://github.com/CommunityToolkit/WindowsCommunityToolkit/tree/main/Microsoft.Toolkit.Uwp.UI.Controls/TextToolbar",
|
||||
"CodeUrl": "https://github.com/CommunityToolkit/WindowsCommunityToolkit/tree/main/Microsoft.Toolkit.Uwp.UI.Controls.Core/TextToolbar",
|
||||
"XamlCodeFile": "AdaptiveGridViewCode.bind",
|
||||
"DocumentationUrl": "https://raw.githubusercontent.com/CommunityToolkit/WindowsCommunityToolkit/main/docs/controls/AdaptiveGridView.md"
|
||||
}
|
||||
|
|
@ -165,48 +171,51 @@ Select the category where you want your page to be listed and add the following
|
|||
]
|
||||
```
|
||||
|
||||
## Thumbnail Images
|
||||
### Thumbnail Images
|
||||
|
||||
> NOTE: If creating a new icon, follow the [Thumbnail Style Guide and templates](https://github.com/CommunityToolkit/WindowsCommunityToolkit-design-assets)
|
||||
For creating new icons, please follow the [Thumbnail Style Guide and templates](https://github.com/CommunityToolkit/WindowsCommunityToolkit-design-assets)
|
||||
|
||||
## Restricting Samples to Specific API Sets
|
||||
### Restricting Samples to Specific API Sets
|
||||
|
||||
Some features used by samples aren't available on all the OS versions that the Sample App runs on. In order to make sure a sample is valid for the host OS, add the `ApiCheck` key/value in your JSON definition.
|
||||
|
||||
The value is a string which is the fully-qualified typename to check for the presence of. You can also accompany this with the `BadgeUpdateVersionRequred` which uses the string provided to show a short message on the sample information so up level implementors know the minimum version required.
|
||||
The value is a string which is the fully-qualified type-name to check for the presence of. You can also accompany this with the `BadgeUpdateVersionRequired` which uses the string provided to show a short message on the sample information so up level implementer know the minimum version required.
|
||||
|
||||
```json
|
||||
{
|
||||
//...
|
||||
// •••
|
||||
"About": "MySample needs 10.0.18362 or higher to work.",
|
||||
"ApiCheck": "Windows.UI.Xaml.Controls.NavigationView",
|
||||
"BadgeUpdateVersionRequired": "Fall Creators Update required",
|
||||
//...
|
||||
// •••
|
||||
}
|
||||
```
|
||||
|
||||
If the specified type is not found on the system running the sample app the sample will not appear in the sample list.
|
||||
If the specified type is not found on the system running the sample app, the sample will not appear in the sample list.
|
||||
|
||||
### Adding documentation
|
||||
#### Adding documentation
|
||||
|
||||
Every API must be accompanied by Markdown documentation in the [documentation repository](..\contributing.md#docs).
|
||||
Every API must be accompanied by Markdown doc in the [documentation](https://github.com/CommunityToolkit/WindowsCommunityToolkit/blob/main/Contributing.md#docs) [repository](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs).
|
||||
|
||||
Use the DocumentationUrl property to add a link to the raw documentation in *samples.json*. Please follow the following pattern:
|
||||
Use the `DocumentationUrl` property to add a link to the raw documentation in *`samples.json`*. Please follow the following pattern:
|
||||
|
||||
`https://raw.githubusercontent.com/MicrosoftDocs/WindowsCommunityToolkitDocs/{branch}/docs/{folder/file.md}`
|
||||
|
||||
> NOTE: When building and running the app in release mode, the branch will automatically be changed to **main** before loading.
|
||||
##### NOTES
|
||||
|
||||
> NOTE: The documentation is also packaged with the sample app. If there is no network connection, or the documentation is not yet on GitHub, the sample app will use the packaged version
|
||||
* When building and running the app in release mode, the branch will automatically be changed to **main** before loading.
|
||||
* The documentation is also packaged with the sample app. If there is no network connection, or the documentation is not yet on GitHub, the sample app will use the packaged version.
|
||||
* To test your documentation in the sample app while running in debug mode, the Docs repository will need to be cloned in the same folder as this repository and named **`WindowsCommunityToolkitDocs`**. For
|
||||
|
||||
> NOTE: To test your documentation in the sample app while running in debug mode, the docs repository will need to be cloned in the same folder as this repository and named **WindowsCommunityToolkitDocs**. For example, this folder structure works best:
|
||||
Example, this folder structure works best:
|
||||
|
||||
> ```
|
||||
> repositories
|
||||
> ├── WindowsCommunityToolkit
|
||||
> ├── WindowsCommunityToolkitDocs
|
||||
> ```
|
||||
```txt
|
||||
Repos
|
||||
├── WindowsCommunityToolkit
|
||||
├── WindowsCommunityToolkitDocs
|
||||
└── Others
|
||||
```
|
||||
|
||||
### CodeUrl
|
||||
#### Using `CodeUrl`
|
||||
|
||||
The value of CodeUrl is modified when the app is built in release mode. The branch is automatically changed to **main**. This allows you to test the link in debug while pointing to dev.
|
||||
The value of `CodeUrl` is modified when the app is built in release mode. The branch is automatically changed to **main**. This allows you to test the link in debug while pointing to dev.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
# Windows Community Toolkit - WPF and Windows Forms
|
||||
# Windows Community Toolkit — WPF and Windows Forms
|
||||
|
||||
The source has moved to a new repository: https://github.com/CommunityToolkit/Microsoft.Toolkit.Win32
|
||||
The source has moved to a new repository: <https://github.com/CommunityToolkit/Microsoft.Toolkit.Win32>
|
||||
|
|
|
|||
32
ReadMe.md
32
ReadMe.md
|
|
@ -1,55 +1,55 @@
|
|||
|
||||
# Windows Community Toolkit :toolbox:
|
||||
# 🧰 Windows Community Toolkit
|
||||
|
||||
The Windows Community Toolkit is a collection of helper functions, custom controls, and app services. It simplifies and demonstrates common developer patterns when building experiences for Windows 10.
|
||||
|
||||
| Target | Branch | Status | Recommended package version |
|
||||
| ------ | ------ | ------ | ------ |
|
||||
| Production | rel/7.0.2 | [](https://dev.azure.com/dotnet/CommunityToolkit/_build/latest?definitionId=10&branchName=rel/7.0.2) | [](https://www.nuget.org/profiles/Microsoft.Toolkit) |
|
||||
| Pre-release beta testing | main | [](https://dev.azure.com/dotnet/CommunityToolkit/_build/latest?definitionId=10) | [](https://dev.azure.com/dotnet/CommunityToolkit/_packaging?_a=feed&feed=CommunityToolkit-MainLatest) |
|
||||
| Previews | main | [](https://dev.azure.com/dotnet/CommunityToolkit/_build/latest?definitionId=10) | [](https://dev.azure.com/dotnet/CommunityToolkit/_packaging?_a=feed&feed=CommunityToolkit-MainLatest) |
|
||||
|
||||
## Getting Started :raised_hands:
|
||||
## 🙌 Getting Started
|
||||
|
||||
Please read the [Getting Started with the Windows Community Toolkit](https://docs.microsoft.com/windows/communitytoolkit/getting-started) page for more detailed information about using the toolkit.
|
||||
|
||||
## Documentation :pencil:
|
||||
## 📃 Documentation
|
||||
|
||||
All documentation for the toolkit is hosted on [Microsoft Docs](https://docs.microsoft.com/windows/communitytoolkit/). All API documentation can be found at the [.NET API Browser](https://docs.microsoft.com/dotnet/api/?view=win-comm-toolkit-dotnet-stable).
|
||||
|
||||
## Windows Community Toolkit Sample App :iphone:
|
||||
## 📱 Windows Community Toolkit Sample App
|
||||
|
||||
Want to see the toolkit in action before jumping into the code? Download and play with the [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9nblggh4tlcq) from the Store.
|
||||
|
||||
## Contribution :rocket:
|
||||
## 🚀 Contribution
|
||||
|
||||
Do you want to contribute? Check out our [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) page to learn more about contribution and guidelines.
|
||||
|
||||
## NuGet Packages :package:
|
||||
## 📦 NuGet Packages
|
||||
|
||||
NuGet is a standard package manager for .NET applications which is built into Visual Studio. When you open solution in Visual Studio, choose the *Tools* menu > *NuGet Package Manager* > *Manage NuGet packages for solution...* Enter one of the package names mentioned in [Windows Community Toolkit Nuget Packages](https://docs.microsoft.com/en-us/windows/communitytoolkit/nuget-packages) table to search for it online.
|
||||
NuGet is a standard package manager for .NET applications which is built into Visual Studio. When you open solution in Visual Studio, choose the *Tools* menu > *NuGet Package Manager* > *Manage NuGet packages for solution…* Enter one of the package names mentioned in [Windows Community Toolkit NuGet Packages](https://docs.microsoft.com/windows/communitytoolkit/nuget-packages) table to search for it online.
|
||||
|
||||
## <a name="supported"></a> Features :mailbox:
|
||||
## 📫 Features <a name="supported"></a>
|
||||
|
||||
The [Features list](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/docs/toc.md#controls) refers to all the currently available features that can be found in the Windows Community Toolkit. Most features should work with the October 2018 Update (1809) SDK 17763 and above; however, refer to specific documentation on each feature for more information.
|
||||
|
||||
## Principles :ballot_box_with_check:
|
||||
## 💠 Principles
|
||||
|
||||
* Principle **#1**: The toolkit will be kept simple.
|
||||
* Principle **#2**: As soon as a comparable feature is available in the Windows SDK for Windows 10, it will be marked as deprecated.
|
||||
* Principle **#3**: All features will be supported for two Windows SDK for Windows 10 release cycles or until another principle supersedes it.
|
||||
1. The toolkit will be kept simple.
|
||||
2. As soon as a comparable feature is available in the Windows SDK for Windows 10, it will be marked as deprecated.
|
||||
3. All features will be supported for two Windows SDK for Windows 10 release cycles or until another principle supersedes it.
|
||||
|
||||
## Roadmap :earth_americas:
|
||||
## 🌍 Roadmap
|
||||
|
||||
Read what we [plan for next iterations](https://github.com/CommunityToolkit/WindowsCommunityToolkit/milestones), and feel free to ask questions.
|
||||
|
||||
Check out our [Preview Packages Wiki Page](https://github.com/CommunityToolkit/WindowsCommunityToolkit/wiki/Preview-Packages) to learn more about updating your NuGet sources in Visual Studio, then you can also get pre-release packages of upcoming versions to try.
|
||||
|
||||
## Code of Conduct :page_facing_up:
|
||||
## 📄 Code of Conduct
|
||||
|
||||
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/)
|
||||
to clarify expected behavior in our community.
|
||||
For more information see the [.NET Foundation Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
## .NET Foundation
|
||||
## 🏢 .NET Foundation
|
||||
|
||||
This project is supported by the [.NET Foundation](http://dotnetfoundation.org).
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче