Skip to content

Docs toolbar component #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Nov 24, 2020
Merged

Docs toolbar component #175

merged 17 commits into from
Nov 24, 2020

Conversation

svdimitr
Copy link
Contributor

@svdimitr svdimitr commented Nov 24, 2020

New Component Checklist (delete for other types of PRs)

  • - Overview article

    • General information on the purpose of the component.
    • Instruction on how to add the component to a razor component.
    • Basic configuration of the component - code snippet with a scenario that is both basic, and meaningful.
    • Provide information on the component's reference.
    • List the available features for the component and/or provide links (slugs) for the articles that explain them in details. For simpler components listing parameters might be enough, for more complex ones sections with a sentence or two that links corresponding articles might be more suitable.
    • Maybe some Example(s) - very common scenarios, notes, typical use case, etc. Not mandatory, depends on the component.
  • - Data binding article - applicable if data can be provided to the component. My be one article or a folder with several articles (examples - DropDownList and TreeView)

  • - Feature/component specific articles - those articles explain the component specific features, which do not suit in any of the before-mentioned articles. Examples of such articles are the Navigator for the Stock Chart, the Indeterminate state for the CheckBox and others.

  • - Selection article - applicable if the component exposes items selection. May be a folder.
    [ ] - Single item selection
    [ ] - Multiple item selection

  • - Templates - applicable if additional customization is allowed with Templates. Usually a folder, see the grid

  • - Events article - applicable if the component expose events.
    Examples of such events could be:

  • OnClick
  • OnChange
  • ValueChanged
  • SelectedItemsChanged
  • OnRead
  • etc.
  • Update Input Validation, Globalization, Keyboard Navigation, Accessibility Compliance articles as applicable.

  • Link from the Overview components list

@svdimitr svdimitr self-assigned this Nov 24, 2020
@svdimitr svdimitr marked this pull request as ready for review November 24, 2020 14:19
@marin-bratanov marin-bratanov merged commit 8ee0ad2 into master Nov 24, 2020
@marin-bratanov marin-bratanov deleted the docs-toolbar-component branch November 24, 2020 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants