hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

UX-2323: Link Guideline, preview image bug fixed, small text changes

Browse Source
This commit is contained in:
eldar-jetbrains 2025-02-04 12:28:27 +01:00
parent 1f3d76cee4
commit a27db5fb02
3 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
images/ui/inspections/link.png → images/ui/inspections/inpsections_link.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 8.4 KiB

After

Width:  |  Height:  |  Size: 8.4 KiB

14
topics/ui/controls/link.md
View File

@ -35,7 +35,7 @@ Use a regular link for navigation between pages of the same window.
Use an external link for navigation to web resources. See below for the [external link icon](#external-link-icon). Use an external link for navigation to web resources. See below for the [external link icon](#external-link-icon).
![Text 'Learn more about what is logged' with 'what is logged' as an external link with arrow icon.](link_when_to_2.png){width=706} ![Text 'Learn more about what is logged' with 'what is logged' as an external link with an arrow icon.](link_when_to_2.png){width=706}
### Secondary actions in packed UI areas ### Secondary actions in packed UI areas
@ -143,7 +143,7 @@ Add an ellipsis to a button-link if it opens another UI area where input is poss
#### Wording #### Wording
Do not use words like "navigate" or "click here". A link already implies navigation or clicking. Do not use words like <code>navigate</code> or <code>click here</code>. A link already implies navigation or clicking.
<table style="none" border="false"> <table style="none" border="false">
<tr> <tr>
@ -173,7 +173,7 @@ Do not use words like "navigate" or "click here". A link already implies navigat
#### Make it informative #### Make it informative
When possible, replace "Learn more" and other generic phrases with more informative ones. When possible, replace <code>Learn more</code> and other generic phrases with more informative ones.
<table style="none" border="false"> <table style="none" border="false">
<tr> <tr>
@ -215,7 +215,9 @@ Add the arrow icon for an external link. The icon shows that the user will switc
![Text 'Learn more about what is logged' where 'what is logged' is an external link with the external link icon.](link_how_to_8.png){width=706} ![Text 'Learn more about what is logged' where 'what is logged' is an external link with the external link icon.](link_how_to_8.png){width=706}
<tabs group="languages"> <chapter title="Implementation" collapsible="true">
<tabs group="languages">
<tab title="Kotlin" group-key="kotlin"> <tab title="Kotlin" group-key="kotlin">
```kotlin ```kotlin
@ -236,7 +238,9 @@ Add the arrow icon for an external link. The icon shows that the user will switc
externalLink.setExternalLinkIcon(); externalLink.setExternalLinkIcon();
``` ```
</tab> </tab>
</tabs> </tabs>
</chapter>
### Help icon ### Help icon

2
topics/ui/text/inspections.md
View File

@ -66,7 +66,7 @@ Provide details, such as:
* A link to the language or framework docs explaining the correct usage of the syntax or feature, if applicable. * A link to the language or framework docs explaining the correct usage of the syntax or feature, if applicable.
![](link.png){width=520} ![](inpsections_link.png){width=520}
* Two code samples: the code with a problem and the code that bypasses this problem. By comparing the good code and the bad code, users can work out what causes the problem and how to avoid it. * Two code samples: the code with a problem and the code that bypasses this problem. By comparing the good code and the bad code, users can work out what causes the problem and how to avoid it.
For example, for <ui-path>Java | Probable bugs | 'equals()' called on array</ui-path> adding such an example helps to understand the inspection quicker: For example, for <ui-path>Java | Probable bugs | 'equals()' called on array</ui-path> adding such an example helps to understand the inspection quicker: