blazor-docs/_config.yml

855 строки
24 KiB
YAML

# The public documentation URL, used for sitemap.xml
url: "https://docs.telerik.com/blazor-ui"
all_pages_domain: "https://docs.telerik.com"
capital_casing_redirects: true
# Exclude files which should not be in the output
exclude: [README.md, Gemfile, Gemfile.lock,api_sort.rb, Dockerfile, bs-config.js, build-docs.sh, copy_content.sh, copy_local.sh, docs-watcher/*, exclude_files.txt, install-npm.sh, start-docs.sh, watch.sh, src-a11y/*]
exclude_navigation: ["knowledge-base/*"]
navigation:
## List your directory names and order here, like this:
"knowledge-base":
title: "Knowledge Base"
position: 40
"api":
title: "API Reference"
position: 0
"getting-started":
title: "Getting Started"
position: 5
"installation":
title: "Installation"
position: 6
"components":
title: "Components"
position: 10
"styling-and-themes":
title: "Styling and Themes"
position: 12
"common-features":
title: "Common Features"
position: 15
"common-features/data-binding":
title: "Data Binding"
position: 0
"globalization":
title: "Globalization"
position: 16
"accessibility":
title: "Accessibility"
position: 17
"*deployment":
title: "Deployment"
position: 18
"upgrade":
title: "Upgrade"
position: 19
"upgrade/breaking-changes":
title: "Breaking Changes"
"upgrade/rendering-changes":
title: "Rendering Changes"
"how-to":
title: "How To"
position: 20
"getting-started/vs-integration":
title: "Visual Studio Integration"
position: 25
"getting-started/vs-code-integration":
title: "Visual Studio Code Integration"
position: 26
"getting-started/repl":
title: "Telerik REPL for Blazor"
position: 35
"backwards-compatibility":
title: "Breaking Changes"
position: 30
"integrations":
title: "Integration With Other Telerik Products"
position: 40
"testing":
title: "Testing"
position: 45
"integrations/document-processing":
title: "Document Processing"
position: 20
## List custom TOC order for folders here
"*components/calendar/templates":
title: "Templates"
position: 20
"*components/form/formitems":
title: "Form Items"
position: 20
"*components/gantt/gantt-tree":
title: "Gantt Tree"
position: 5
"*components/gantt/dependencies":
title: "Gantt Dependencies"
position: 15
"*components/gantt/timeline":
title: "Gantt Timeline"
position: 10
"*components/gantt/gantt-tree/data-binding":
title: "Data Binding"
position: 5
"*components/gantt/gantt-tree/columns":
title: "Columns"
position: 7
"*components/gantt/gantt-tree/editing":
title: "Editing"
position: 10
"*components/gantt/gantt-tree/filter":
title: "Filtering"
position: 25
"*components/gantt/timeline/templates":
title: "Templates"
position: 15
"*components/grid/columns":
title: "Columns"
position: 5
"*components/grid/editing":
title: "Editing"
position: 10
"*components/grid/editing/built-in-dialogs":
title: "Built-in Dialogs"
position: 17
"*components/grid/filter":
title: "Filtering"
position: 22
"*components/grid/grouping":
title: "Grouping"
position: 24
"*components/grid/templates":
title: "Templates"
position: 25
"*components/grid/export":
title: "Export"
position: 30
"*components/grid/selection":
title: "Selection"
position: 35
"*components/multicolumncombobox/columns":
title: "Columns"
position: 7
"*components/treelist/data-binding":
title: "Data Binding"
position: 2
"*components/treelist/columns":
title: "Columns"
position: 5
"*components/treelist/editing":
title: "Editing"
position: 10
"*components/treelist/editing/built-in-dialogs":
title: "Built-in Dialogs"
position: 17
"*components/treelist/filter":
title: "Filtering"
position: 22
"*components/treelist/templates":
title: "Templates"
position: 25
"*components/treelist/export":
title: "Export"
position: 30
"*components/treelist/selection":
title: "Selection"
position: 35
"*components/chart/types":
title: "Types"
position: 15
"*components/chart/pan-and-zoom":
title: "Pan and Zoom"
position: 32
"*components/chart/tooltip":
title: "Tooltips"
position: 31
"*components/stockchart/types":
title: "Types"
position: 12
"*components/stockchart/tooltip":
title: "Tooltips"
position: 22
"*components/animationcontainer":
title: "Animation Container"
position: 2000000
"*components/document-processing":
title: "Document Processing"
position: 2200000
"*components/treeview/data-binding":
title: "Data Binding"
position: 2
"*components/treeview/selection":
title: "Selection"
position: 3
"*components/treeview/checkboxes":
title: "CheckBoxes"
position: 4
"*components/contextmenu/data-binding":
title: "Data Binding"
position: 2
"*components/contextmenu/templates":
title: "Templates"
position: 25
"*components/menu/data-binding":
title: "Data Binding"
position: 2
"*components/scheduler/appointments":
title: "Appointments"
position: 2
"*components/scheduler/editing":
title: "Editing"
position: 3
"*components/scheduler/views":
title: "Views"
position: 5
"*components/scheduler/templates":
title: "Templates"
position: 10
"*components/editor/edit-modes":
title: "Edit Modes"
position: 80
"*components/panelbar/data-binding":
title: "Data Binding"
position: 2
"*components/panelbar/templates":
title: "Templates"
position: 10
"*components/stepper/steps":
title: "Steps"
position: 3
"*components/wizard/structure":
title: "Structure"
position: 3
"*components/filemanager/data-binding":
title: "Data Binding"
position: 2
"*components/aiprompt/views":
title: "Views"
position: 10
## List helpers directory names and order here, like this:
"*appearance":
title: "Appearance"
"*accessibility":
title: "Accessibility"
"*binding":
title: "Binding"
position: 2
"*troubleshooting":
title: "Troubleshooting"
position: 50
"*editing":
title: "Editing"
"*export":
title: "Export"
"*filtering":
title: "Filtering"
"*integration":
title: "Integration"
"*selection":
title: "Selection"
"*state":
title: "State Management"
"*how-to":
title: "How To"
"*/grid":
title: "Grid"
"*gridlayout":
title: "Grid Layout"
"*listview":
title: "ListView"
"*treelist":
title: "TreeList"
"*spreadsheet":
title: "Spreadsheet"
"*gauges/arc":
title: "Arc"
"*aiprompt":
title: "AIPrompt"
"*appbar":
title: "AppBar"
"*popup":
title: "Popup"
"*autocomplete":
title: "AutoComplete"
"*avatar":
title: "Avatar"
"*barcodes":
title: "Barcodes"
"*barcode":
title: "Barcode"
"*togglebutton":
title: "ToggleButton"
"*breadcrumb":
title: "Breadcrumb"
"*/button":
title: "Button"
"*buttongroup":
title: "ButtonGroup"
"html-helpers/scheduling/calendar":
title: "Calendar"
"html-helpers/scheduling/multiviewcalendar":
title: "MultiViewCalendar"
"tag-helpers/scheduling/multiviewcalendar":
title: "MultiViewCalendar"
"*calendar":
title: "Calendar"
"*card":
title: "Card"
"*carousel":
title: "Carousel"
"*components/chart":
title: "Chart"
"*checkbox":
title: "Checkbox"
"*chip":
title: "Chip"
"*chiplist":
title: "ChipList"
"*chunkprogressbar":
title: "ChunkProgressBar"
"*colorgradient":
title: "ColorGradient"
isNew: true
"*colorpalette":
title: "ColorPalette"
isNew: true
"*/colorpicker":
title: "ColorPicker"
"*/multicolumncombobox":
isNew: true
title: "MultiColumnComboBox"
"*combobox":
title: "ComboBox"
"*contextmenu":
title: "Context Menu"
"*dateinput":
title: "Date Input"
"*datepicker":
title: "Date Picker"
"*daterangepicker":
title: "DateRange Picker"
"*datetimepicker":
title: "DateTime Picker"
"*dialog":
title: "Dialog"
"*draganddrop":
title: "DragAndDrop"
"*drawer":
title: "Drawer"
"*dropdownbutton":
title: "DropDownButton"
"*dropdownlist":
title: "DropDownList"
"*dropzone":
title: "DropZone"
"*dropdowntree":
isNew: true
title: "DropDownTree"
"*editor":
title: "Editor"
"*filemanager":
title: "FileManager"
"*fileselect":
title: "FileSelect"
"*filter":
title: "Filter"
"*fields":
title: "Fields"
position: 2
"*form":
title: "Form"
"*flatcolorpicker":
title: "FlatColorPicker"
"*floatinglabel":
title: "FloatingLabel"
"*gantt":
title: "Gantt"
"*gauges":
title: "Gauges"
"*gauges/linear":
title: "Linear"
"*gauges/circular":
title: "Circular"
"*listbox":
title: "ListBox"
"*loader":
title: "Loader"
"*loadercontainer":
title: "LoaderContainer"
"*map":
title: "Map"
"*layers":
title: "Layers"
position: 10
"*maskedtextbox":
title: "MaskedTextBox"
"*mediaplayer":
title: "MediaPlayer"
"*mediaquery":
title: "MediaQuery"
"*menu":
title: "Menu"
"*multiselect":
title: "MultiSelect"
"*notification":
title: "Notification"
"*popup":
title: "Popup"
"*popover":
title: "Popover"
"*numerictextbox":
title: "NumericTextBox"
"*pdfviewer":
title: "PDF Viewer"
"*progressbar":
title: "ProgressBar"
"*qrcode":
title: "QRCode"
"*/radiobutton":
title: "RadioButton"
"*gauges/radial":
title: "Radial"
"*rangeslider":
title: "RangeSlider"
"*responsivepanel":
title: "ResponsivePanel"
"*panelbar":
title: "PanelBar"
"*pager":
title: "Pager"
"*pivotgrid":
title: "PivotGrid"
"*/radiogroup":
title: "RadioGroup"
"*rootcomponent":
title: "RootComponent"
"*scheduler":
title: "Scheduler"
"*scrollview":
title: "ScrollView"
"*signature":
title: "Signature"
"*slider":
title: "Slider"
"*skeleton":
title: "Skeleton"
"*sortable":
title: "Sortable"
"*splitbutton":
title: "SplitButton"
"*splitter":
title: "Splitter"
"*stacklayout":
title: "Stack Layout"
"*stepper":
title: "Stepper"
"*stockchart":
title: "Stock Chart"
"*switch":
title: "Switch"
"*tabstrip":
title: "TabStrip"
"*textbox":
title: "TextBox"
"*textarea":
title: "TextArea"
"*tilelayout":
title: "TileLayout"
"*timepicker":
title: "TimePicker"
"*tooltip":
title: "Tooltip"
"*toolbar":
title: "ToolBar"
"*treelist":
title: "TreeList"
"*treeview":
title: "TreeView"
"*treemap":
title: "TreeMap"
"*upload":
title: "Upload"
"*validation":
title: "Validation Tools"
"*validator":
title: "Validator"
"*window":
title: "Window"
"*wizard":
title: "Wizard"
"*templates":
title: "Templates"
## introduction article columns. Use the slugs in the items collection
api_reference_url: "api/"
intro_columns:
-
categories:
-
title: "Data Management"
items:
"Filter": "filter-overview"
"Grid": "grid-overview"
"ListView": "listview-overview"
"Pager": "pager-overview"
"PivotGrid": "pivotgrid-overview"
"TreeList": "treelist-overview"
-
title: "File Management"
items:
"DropZone": "dropzone-overview"
"FileManager": "filemanager-overview"
"FileSelect": "fileselect-overview"
"Upload": "upload-overview"
-
title: "Navigation"
items:
"Breadcrumb": "breadcrumb-overview"
"Button": "components/button/overview"
"Button Group": "buttongroup-overview"
"Toggle Button": "togglebutton-overview"
"Drawer": "drawer-overview"
"DropDownButton": "dropdownbutton-overview"
"Menu": "components/menu/overview"
"Context Menu": "contextmenu-overview"
"PanelBar": "panelbar-overview"
"SplitButton": "splitbutton-overview"
"Stepper": "stepper-overview"
"Tab Strip": "components/tabstrip/overview"
"ToolBar": "toolbar-overview"
"TreeView": "treeview-overview"
"Wizard": "wizard-overview"
-
title: "Maps"
items:
"Map": "components/map/overview"
-
categories:
-
title: "Editors"
items:
"AutoComplete": "autocomplete-overview"
"CheckBox": "checkbox-overview"
"Color Gradient": "colorgradient-overview"
"Color Palette": "colorpalette-overview"
"Color Picker": "colorpicker-overview"
"Flat Color Picker": "flatcolorpicker-overview"
"ComboBox": "components/combobox/overview"
"MultiColumnComboBox": "multicolumncombobox-overview"
"Date Input": "components/dateinput/overview"
"Date Picker": "components/datepicker/overview"
"Time Picker": "components/timepicker/overview"
"DateTime Picker": "components/datetimepicker/overview"
"DateRange Picker": "daterangepicker-overview"
"DropDownList": "components/dropdownlist/overview"
"HTML Editor": "editor-overview"
"ListBox": "listbox-overview"
"Masked Textbox": "maskedtextbox-overview"
"MultiSelect": "multiselect-overview"
"Numeric Textbox": "components/numerictextbox/overview"
"Radio Button Group": "radiogroup-overview"
"RangeSlider": "rangeslider-overview"
"Signature": "signature-overview"
"Slider": "slider-overview"
"Switch": "switch-overview"
"TextArea": "textarea-overview"
"TextBox": "components/textbox/overview"
"Validation Tools": "validation-tools-overview"
-
title: "Labels"
items:
"FloatingLabel": "floatinglabel-overview"
-
categories:
-
title: "Scheduling"
items:
"Calendar": "components/calendar/overview"
"Gantt": "gantt-overview"
"Scheduler": "scheduler-overview"
-
title: "Charts"
items:
"Charts Overview": "components/chart/overview"
"Area Charts": "components/chart/types/area"
"Bar Charts": "components/chart/types/bar"
"Bubble Charts": "components/chart/types/bubble"
"Candlestick Charts": "chart-types-candlestick"
"Column Charts": "components/chart/types/column"
"Donut Charts": "components/chart/types/donut"
"Heatmap Charts": "chart-types-heatmap"
"Line Charts": "components/chart/types/line"
"OHLC Charts": "chart-types-ohlc"
"Pie Charts": "components/chart/types/pie"
"Radar Area Charts": "chart-types-radararea"
"Radar Column Charts": "chart-types-radarcolumn"
"Radar Line Charts": "chart-types-radarline"
"Scatter Charts": "components/chart/types/scatter"
"Scatter Line Charts": "components/chart/types/scatterline"
"Stock Chart": "stockchart-overview"
-
title: "Gauges"
items:
"Arc Gauge": "arc-gauge-overview"
"Circular Gauge": "circular-gauge-overview"
"Linear Gauge": "linear-gauge-overview"
"Radial Gauge": "radial-gauge-overview"
-
title: "Barcodes"
items:
"Barcode": "barcode-overview"
"QR Code": "qrcode-overview"
-
-
categories:
-
title: "Layout"
items:
"AppBar": "appbar-overview"
"Animation Container": "components/animationcontainer/overview"
"Card": "card-overview"
"Carousel": "carousel-overview"
"Dialog": "dialog-overview"
"Form": "form-overview"
"Grid Layout": "gridlayout-overview"
"Media Query": "mediaquery-overview"
"Tile Layout": "tilelayout-overview"
"Splitter": "splitter-overview"
"Stack Layout": "stacklayout-overview"
"Window": "window-overview"
-
title: "Interactivity and UX"
items:
"AIPrompt": "aiprompt-overview"
"Loader": "loader-overview"
"LoaderContainer": "loadercontainer-overview"
"Skeleton": "skeleton-overview"
"Notification": "notification-overview"
"Progress Bar": "progressbar-overview"
"Chunk Progress Bar": "chunkprogressbar-overview"
"Popover": "popover-overview"
"Tooltip": "tooltip-overview"
"Popup": "popup-overview"
-
title: "Documents"
items:
"Document Processing": "common-features-dpl"
"PdfProcessing": "pdfprocessing-overview"
"SpreadProcessing": "spreadprocessing-overview"
"SpreadStreamProcessing": "spreadstreamprocessing-overview"
"WordsProcessing": "wordsprocessing-overview"
"ZipLibrary": "ziplibrary-overview"
## The application virtual path
baseurl: /blazor-ui
## Enable Blazor Repl
enable_blazorRepl: true
## Latest UI for Blazor version. Used in some articles
uiForBlazorLatestVersion: "5.1.1"
## Compatible theme version for CDN URLs
themeCdnVersion: "7.2.0"
## Product
product: "Telerik UI for Blazor"
platform: blazor
## CTA panels on every page for trials
has_cta_panels: true
## CTA overrides for docs-seed
cta_panels_data_overwrites:
message: "professional grade UI library with 110+ native components for building modern and feature-rich applications."
## Color Scheme
main_theme: blazor
## Assign layout and category per different paths
defaults:
-
scope:
path: ""
values:
layout: "documentation"
category: "default"
product: "blazor"
editable: true
description_suffix: "Read more in Telerik UI for Blazor Documentation."
-
scope:
path: "blazor"
values:
product: "blazor"
-
scope:
path: "api"
values:
editable: false
res_type: api
kind: api
-
scope:
path: "components"
values:
title_prefix: "Blazor"
title_prefix_separator: " "
-
scope:
path: "themes"
values:
title_prefix: "Blazor"
title_prefix_separator: " "
-
scope:
path: "common-features"
values:
title_prefix: "Blazor"
title_prefix_separator: " "
-
scope:
path: "common-features/data-binding"
values:
title_prefix: ""
title_prefix_separator: ""
-
scope:
path: "globalization"
values:
title_prefix: "Blazor"
title_prefix_separator: " "
-
scope:
path: "accessibility"
values:
title_prefix: "Blazor"
title_prefix_separator: " "
-
scope:
path: "themes"
values:
title_prefix: "Blazor"
title_prefix_separator: " "
-
scope:
path: "knowledge-base"
values:
layout: "documentation"
category: "default"
product: "blazor"
editable: true
description_suffix: "Read more in our Blazor Knowledge Base articles."
-
scope:
path: "web.config"
values:
layout: null
#-
# scope:
# path: ""
# values:
# announcement: |
# NEW: Telerik UI R2 2021 Release Webinar on May 18 | 11:00 AM ET. <a href="https://www.telerik.com/campaigns/wb-telerik-r2-2021-release-webinar-web-desktop-and-mobile-products" target="_blank">Save your seat</a>!
#type_links:
# "kendo.Class": "/api/javascript/class"
# "kendo.data.DataSource": "/api/javascript/data/datasource"
# "Array": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array"
# "Blob": "https://developer.mozilla.org/en/docs/Web/API/Blob"
# "File": "https://developer.mozilla.org/en-US/docs/Web/API/File"
# "Boolean": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean"
# "Function": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function"
# "jQuery": "http://api.jquery.com/Types/#jQuery"
# "Promise": "http://api.jquery.com/Types/#Promise"
# "Object": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object"
# "Number": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number"
# "String": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String"
# Aliases available in the markdown template. The below will expand {{site.foo}} to Bar in the output
# "foo": "Bar"
# The google services configuration
google_tag_manager: GTM-6X92
gcs_engine: 001595215763381649090:3v0klcxtf1c
gcs_api_key: AIzaSyDqCekEzmMvnB7i00Xcw_Vy43a7-wePuXQ
#Feedback Form Google Sheet ID
ff-sheet-id: 0c41d166-7ba6-3500-20d5-609d41442f92
# improved feedback form
feedback_ab: true
# other settings
skip_tabbed_code: true
code_lang: true
has_kb_portal: true
edit_repo_url: https://github.com/telerik/blazor-docs/edit/master
product_url: https://www.telerik.com/blazor-ui
download: https://www.telerik.com/download-trial-file/v2-b/ui-for-blazor
footer:
-
title: "Getting Started"
links:
"Client-side Blazor": https://docs.telerik.com/blazor-ui/getting-started/client-blazor
"Server-side Blazor": https://docs.telerik.com/blazor-ui/getting-started/server-blazor
"Blazor Introduction Videos" : https://www.youtube.com/watch?v=aaRAZYaJ4xc&list=PLvmaC-XMqeBYPTwcm478vs8Rujq2tiVJo
-
title: "Community"
links:
"Forums": https://www.telerik.com/forums/blazor
"Blogs": https://www.telerik.com/blogs/tag/blazor
"Feedback Portal": https://feedback.telerik.com/blazor
-
title: "Support Resources"
links:
"Demos": https://demos.telerik.com/blazor-ui
"Knowledge Base": https://docs.telerik.com/blazor-ui/knowledge-base
"Samples Repo": https://github.com/telerik/blazor-ui
"Localizations Repo": https://github.com/telerik/blazor-ui-messages
-
title: "Sample Applications"
links:
"Dashboard": https://demos.telerik.com/blazor-dashboard-app/
"PWA - Stocks": https://demos.telerik.com/blazor-financial-portfolio/
"PWA - Blazing Coffee Roasters": https://demos.telerik.com/blazor-coffee/
footer_social:
facebook: https://www.facebook.com/Telerik/
youtube: https://www.youtube.com/user/TelerikInc
linkedin: https://www.linkedin.com/showcase/telerik/
twitter: https://twitter.com/Telerik/
# Assets pipeline configuration
use_cachebusting: false
# These may be obsolete, but avoid touching just in case
assets:
cachebust: soft
js_compressor: uglifier
gzip: false
## Do not edit below this line
safe: false
markdown: MarkdownProcessor