From af426a6093226b551e91ac282108c85f77a9e9f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yann=20C=C3=A9bron?= Date: Thu, 29 Sep 2022 13:26:54 +0200 Subject: [PATCH] more Platform UI links --- topics/basics/basic_action_system.md | 2 ++ topics/basics/getting_started/theme/themes_customize.md | 6 ++++++ .../syntax_highlighting_and_error_highlighting.md | 2 ++ topics/user_interface_components/dialog_wrapper.md | 6 ++++++ topics/user_interface_components/kotlin_ui_dsl.md | 6 ++++++ .../user_interface_components/kotlin_ui_dsl_version_2.md | 6 ++++++ topics/user_interface_components/notifications.md | 8 ++++++-- .../user_interface_components.md | 6 ++++++ 8 files changed, 40 insertions(+), 2 deletions(-) diff --git a/topics/basics/basic_action_system.md b/topics/basics/basic_action_system.md index a6b99e593..36fe74868 100644 --- a/topics/basics/basic_action_system.md +++ b/topics/basics/basic_action_system.md @@ -6,6 +6,8 @@ **Product Help:** [Menus and toolbars](https://www.jetbrains.com/help/idea/customize-actions-menus-and-toolbars.html) +**Platform UI Guidelines:** [Toolbar](https://jetbrains.design/intellij/controls/toolbar/) + The actions system allows plugins to add their items to IntelliJ Platform-based IDE menus and toolbars. diff --git a/topics/basics/getting_started/theme/themes_customize.md b/topics/basics/getting_started/theme/themes_customize.md index 54d4ad780..fbfb49c7c 100644 --- a/topics/basics/getting_started/theme/themes_customize.md +++ b/topics/basics/getting_started/theme/themes_customize.md @@ -2,6 +2,12 @@ + + +**Platform UI Guidelines:** [Icons](https://jetbrains.design/intellij/principles/icons/), [Platform theme colors](https://jetbrains.design/intellij/principles/platform_theme_colors/#UI-components) + + + Customizing UI controls and icons in a theme plugin. A theme is customized by adding information to the theme description file that overrides the base (_Light_ or _Darcula_) theme. diff --git a/topics/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md b/topics/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md index cac57316a..0f569b035 100644 --- a/topics/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md +++ b/topics/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md @@ -6,6 +6,8 @@ **Product Help:** [Colors and fonts](https://www.jetbrains.com/help/idea/configuring-colors-and-fonts.html) +**Platform UI Guidelines:** [Inspections](https://jetbrains.design/intellij/text/inspections/) + The class used to specify how a particular range of text should be highlighted is called [`TextAttributesKey`](%gh-ic%/platform/core-api/src/com/intellij/openapi/editor/colors/TextAttributesKey.java). diff --git a/topics/user_interface_components/dialog_wrapper.md b/topics/user_interface_components/dialog_wrapper.md index d34f8b498..5957ffcd9 100644 --- a/topics/user_interface_components/dialog_wrapper.md +++ b/topics/user_interface_components/dialog_wrapper.md @@ -2,6 +2,12 @@ + + +**Platform UI Guidelines:** [Layout](https://jetbrains.design/intellij/principles/layout), [Validation errors](https://jetbrains.design/intellij/principles/validation_errors/) + + + ## DialogWrapper The [`DialogWrapper`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/ui/DialogWrapper.java) is the base class which is supposed to be used for all modal dialogs (and some non-modal dialogs) shown in IntelliJ Platform. diff --git a/topics/user_interface_components/kotlin_ui_dsl.md b/topics/user_interface_components/kotlin_ui_dsl.md index 6849563f1..978320249 100644 --- a/topics/user_interface_components/kotlin_ui_dsl.md +++ b/topics/user_interface_components/kotlin_ui_dsl.md @@ -2,6 +2,12 @@ + + +**Platform UI Guidelines:** [Layout](https://jetbrains.design/intellij/principles/layout) + + + Kotlin UI DSL allows creating UI forms with input components bound to state objects. The forms are built by using a declarative Kotlin syntax. It shares similarities with [Jetpack Compose](https://developer.android.com/jetpack/compose) for Android and is intended to build UI forms or part of forms for, e.g. dialogs and settings pages. diff --git a/topics/user_interface_components/kotlin_ui_dsl_version_2.md b/topics/user_interface_components/kotlin_ui_dsl_version_2.md index 73a8a1afb..1535d9b5a 100644 --- a/topics/user_interface_components/kotlin_ui_dsl_version_2.md +++ b/topics/user_interface_components/kotlin_ui_dsl_version_2.md @@ -2,6 +2,12 @@ + + +**Platform UI Guidelines:** [Layout](https://jetbrains.design/intellij/principles/layout) + + + > This page describes API available in IntelliJ Platform releases **2021.3 and later** only. > > See [](kotlin_ui_dsl.md) for targeting earlier releases. diff --git a/topics/user_interface_components/notifications.md b/topics/user_interface_components/notifications.md index ec49171cb..04957015f 100644 --- a/topics/user_interface_components/notifications.md +++ b/topics/user_interface_components/notifications.md @@ -2,11 +2,15 @@ + + +**Platform UI Guidelines:** [Notifications](https://jetbrains.design/intellij/controls/notifications/), [Banner](https://jetbrains.design/intellij/controls/banner/), [Got It tooltip](https://jetbrains.design/intellij/controls/got_it_tooltip/), [Balloon](https://jetbrains.design/intellij/controls/balloon/) + + + One of the leading design principles is avoiding the use of modal message boxes for notifying the user about errors and other situations that may warrant the user's attention. As a replacement, the IntelliJ Platform provides multiple non-modal notification UI options. -For an overview, refer to [Notifications](https://jetbrains.design/intellij/controls/notifications/) in IntelliJ Platform UI Guidelines. - ### Dialogs When working in dialog, instead of checking the validity of the input when the _OK_ button is pressed and notifying the user about invalid data with a modal dialog, the recommended approach is to use [`DialogWrapper.doValidate()`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/ui/DialogWrapper.java), which was described previously. diff --git a/topics/user_interface_components/user_interface_components.md b/topics/user_interface_components/user_interface_components.md index 193c05550..ecd96ff2a 100644 --- a/topics/user_interface_components/user_interface_components.md +++ b/topics/user_interface_components/user_interface_components.md @@ -2,6 +2,12 @@ + + +**Platform UI Guidelines:** [Overview](https://jetbrains.design/intellij/) + + + The IntelliJ Platform includes a large number of custom Swing components. Using those components in your plugins will ensure that your plugin looks and works consistently with the UI of the rest of the IDE, and can often reduce the code size compared to using the default Swing components.