mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-30 18:27:49 +08:00
d8e83b57ea
* Add UI Guidelines to SDK docs * Add UI Guidelines to SDK docs * Fixing build errors * optimize PNGs * add UI guidelines landing page placeholder * IJ SDK Docs <-> UI guidelines crosslinks updated * split_button.md: remove reference to removed setting * use <ui-path> * use MD instead of <note> * use %gh-ic% links * drop_down.md: fix <control> * code samples: fix most obvious issues * remove obsolete `_defaults.md` * ijs.tree: UI cleanup * Delete "under construction" pages * Fix headers * Add link-summary * Remove invalid links * Delete unused files * Remove ''@2x' from image file names * Use Markdown syntax for some images and tables * Rename non-unique files to unique * Remove alpha in images where content is unreadable * align quotation marks * Controls: cleanup/fixes, add code links, edit * tooltip.md: fix HTML * misc fixes * typography.md: fix table contents * typography.md: fix table header * UI guidelines landing page + TOC fixes * remove unused icons_list.md * Normalize image paths * validation_errors.md: Fix broken tab * "correct"/"incorrect" labels styling * Resize images to 50% * button.topic: fixes * grammar, spelling, minor edits * remove ' ' * fix 99px * cleanup * UI_kit.md: minor * Fix "MRK058: Large image in paragraph rendered as a block element by default." * button.topic: Add img[alt] * mnemonics.md: Update "Contact Us" link to the IJSDK YouTrack * split_button.md: Use ui-path * UI landing: add feedback snippet * Improve code snippets formatting and naming * Fix code samples * Fix code samples * Add Kotlin variants for code samples * Add icons_list.md * crosslinks * Change external link to https://intellij-icons.jetbrains.design/ * icons list -> https://intellij-icons.jetbrains.design * Hide info about reducing split button to simple action button (now it is available through the registry only) * reformat * icons_style.md: Images in new line --------- Co-authored-by: marianna.kononenko <marianna.kononenko@jetbrains.com> Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>
106 lines
2.8 KiB
Markdown
106 lines
2.8 KiB
Markdown
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
|
|
|
# UI Guidelines
|
|
|
|
<link-summary>Creating consistent and usable user interfaces.</link-summary>
|
|
|
|
When working on an IntelliJ Platform-based IDE or a plugin, use these guidelines to create consistent and usable user interfaces.
|
|
|
|
> Topics in <format color="Gray">gray text</format> are not available yet.
|
|
>
|
|
{style="note"}
|
|
|
|
## Controls
|
|
|
|
- [](button.topic)
|
|
- [](built_in_button.md)
|
|
- [](split_button.md)
|
|
- [](checkbox.md)
|
|
- [](combo_box.md)
|
|
- [](context_help.md)
|
|
- [](inline_help_text.md)
|
|
- [](tooltip.md)
|
|
- [](empty_state.md)
|
|
- [](description_text.md)
|
|
- [](drop_down.md)
|
|
- [](got_it_tooltip.md)
|
|
- [](group_header.md)
|
|
- [](input_field.md)
|
|
- [](link.md)
|
|
- <format color="Gray">List</format>
|
|
- <format color="Gray">Menu</format>
|
|
- <format color="Gray">Context Menu</format>
|
|
- <format color="Gray">Menu List</format>
|
|
- [](notification_types.md)
|
|
- <format color="Gray">Alert</format>
|
|
- [](balloon.md)
|
|
- [](banner.md)
|
|
- <format color="Gray">Tool Window Balloon</format>
|
|
- [](progress_indicators.md)
|
|
- [](loader.md)
|
|
- [](progress_bar.md)
|
|
- [](progress_text.md)
|
|
- [](radio_button.md)
|
|
- [](scrollbar.md)
|
|
- [](search_field.md)
|
|
- <format color="Gray">Slider</format>
|
|
- [](table.md)
|
|
- [](tabs.md)
|
|
- [](text_area.md)
|
|
- [](toggle_button.md)
|
|
- [](toolbar.md)
|
|
- [](icon_button.md)
|
|
- [](split_icon_button.md)
|
|
- [](toolbar_drop_down.md)
|
|
- <format color="Gray">Tree</format>
|
|
- {columns="4"}
|
|
|
|
## Components
|
|
|
|
- <format color="Gray">Dialog Window</format>
|
|
- <format color="Gray">Popup</format>
|
|
- <format color="Gray">Status Bar</format>
|
|
- [](tool_window.md)
|
|
- {columns="4"}
|
|
|
|
## Text
|
|
|
|
- [](capitalization.md)
|
|
- [](inspections.md)
|
|
- [](punctuation.md)
|
|
- <format color="Gray">Notification and Error Texts</format>
|
|
- <format color="Gray">Terminology</format>
|
|
- [](writing_short.md)
|
|
- {columns="4"}
|
|
|
|
## Principles
|
|
|
|
- <format color="Gray">Accessibility</format>
|
|
- <format color="Gray">Dangerous Actions</format>
|
|
- [](data_formats.md)
|
|
- <format color="Gray">Default Values</format>
|
|
- <format color="Gray">Discoverability</format>
|
|
- [](icons_style.md)
|
|
- [](layout.md)
|
|
- [](groups_of_controls.md)
|
|
- <format color="Gray">Master-detail Layout</format>
|
|
- <format color="Gray">Sizes and Insets</format>
|
|
- [](mnemonics.md)
|
|
- [](platform_theme_colors.md)
|
|
- <format color="Gray">Search</format>
|
|
- <format color="Gray">Search Results</format>
|
|
- <format color="Gray">Speed Search</format>
|
|
- <format color="Gray">Sharing Settings</format>
|
|
- [](typography.md)
|
|
- <format color="Gray">UI Feedback</format>
|
|
- [](validation_errors.md)
|
|
- {columns="4"}
|
|
|
|
## Resources
|
|
|
|
- [Icons List](https://intellij-icons.jetbrains.design)
|
|
- [](UI_kit.md)
|
|
- {columns="4"}
|
|
|
|
<include from="snippets.md" element-id="missingContent"/>
|