You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Interaction_Guidelines/ux_build_test.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Once you're ready to go, you can start building and customizing your extension.
21
21
22
22
*[Extensions API Documentation](https://tableau.github.io/extensions-api/)<br>The Extensions API includes all the information you need to build an extension.
23
23
24
-
*[Community Forums](https://community.tableau.com/community/developers/extensions-api/overview)<br>Participate in a community of developers that are passionate about creating extensions.
24
+
*[Community Forums](https://community.tableau.com/s/topic/0TO4T000000QFALWA4/extensions-api)<br>Participate in a community of developers that are passionate about creating extensions.
25
25
26
26
*[Tableau Exchange](https://exchange.tableau.com/)<br>Explore and use some of the extensions our partners have created.
27
27
@@ -45,7 +45,7 @@ After you've completed making your extension, you may want to share your extensi
45
45
Tableau has released the [Extension Gallery](https://extensiongallery.tableau.com/), a place to explore and download some extensions that our partners have created. If you would like to share your extension to our gallery, learn more at [Sharing to the Extension Gallery]({{site.baseurl}}/docs/ux_extension_gallery.html).
46
46
47
47
##### Community Forums
48
-
Tableau also has a [Community Forum](https://community.tableau.com/community/developers/extensions-api/overview) for developers to discuss extensions and the Extensions API.
48
+
Tableau also has a [Community Forum](https://community.tableau.com/s/topic/0TO4T000000QFALWA4/extensions-api) for developers to discuss extensions and the Extensions API.
Copy file name to clipboardExpand all lines: docs/Interaction_Guidelines/ux_controls_ui_patterns.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ We've provided examples of controls that are used in Tableau. Using the exact st
15
15
*[Text Fields](#text-fields)
16
16
*[Tooltips](#tooltips)
17
17
18
-
The controls described here use Tableau branding, accessible from the **[Color](Style Guidelines/6 - Color.md)** and **[Fonts](Style Guidelines/7 - Fonts.md)** sections of these design guidelines.
18
+
The controls described here use Tableau branding, accessible from the **[Color](../Style_Guidelines/ux_color.md)** and **[Fonts](../Style_Guidelines/ux_fonts.md)** sections of these design guidelines.
19
19
20
20
###### *At this time, we are only able to provide surface-level usage and design specifications for controls. We are working to make code for Tableau controls accessible to developers in the future.*
21
21
@@ -62,7 +62,7 @@ A button communicates what happens when a user touches it. Button labels can con
62
62
63
63
| Button | How to use |
64
64
|----|:-----|
65
-
|**Call-to-Action **| These buttons are primarily used in dialogues to indicate an action. Use colors to communicate function–for example, green is commonly used for confirmation buttons. Learn more about color usage at **[Colors](Style Guidelines/6 - Color.md)**.<br><br>You may also want to utilize branding practices on buttons. Learn more at **[Branding your Extension](Style Guidelines/4 - Branding your Extension.md)**. |
65
+
|**Call-to-Action **| These buttons are primarily used in dialogues to indicate an action. Use colors to communicate function–for example, green is commonly used for confirmation buttons. Learn more about color usage at **[Colors](../Style_Guidelines/ux_color.md)**.<br><br>You may also want to utilize branding practices on buttons. Learn more at **[Branding your Extension](../Style_Guidelines/ux_branding.md)**. |
66
66
|**Greyscale**| Greyscale buttons are used either to indicate a secondary action, or a button that has been disabled and a particular action needs to be taken before proceeding. |
67
67
|**Text Button **| This is a low-attention button, and should only be used to provide a secondary option in the case that the user wants to perform an action that isn’t the primary action. |
68
68
|**Icon**| Buttons can have icons to add a helpful visual. If you use icons, include a text label or a help tag that is activated on hover. |
@@ -101,7 +101,7 @@ Primary buttons apply only to Call-to-Action buttons.
101
101
102
102
## Dialogs
103
103
104
-
A dialog is a “conversation” between the system and the user, which often requests information or action from the user. For info about the extension configuration dialog, learn more at **[Extension Components and Modes](2 - Extension Components and Modes.md)**.
104
+
A dialog is a “conversation” between the system and the user, which often requests information or action from the user. For info about the extension configuration dialog, learn more at **[Extension Components and Modes](ux_components_modes.md)**.
105
105
106
106
### Standard Dialog
107
107
These dialogs are non-modal, meaning they can be used when the requested information is not essential to continue. The dialog can be left open while the user interacts with other components in the extension.
The developer's roadmap for how to get started developing and designing extensions.
5
5
6
6
7
7
8
-
### [2 – Extension Components and Modes](Interaction Guidelines/2 - Extension Components and Modes.md)
8
+
### [2 – Extension Components and Modes](ux_components_modes.md)
9
9
The main user-facing components of an extension to create content for. Learn about modes for configuring extensions, viewing extensions, and dashboard user types.
10
10
11
11
12
12
13
-
### [3 – Controls and UI Patterns](Interaction Guidelines/3 - Controls and UI Patterns.md)
13
+
### [3 – Controls and UI Patterns](ux_controls_ui_patterns.md)
14
14
Usage and design specifications for user interface controls and patterns in your extension.
15
15
16
16
###### *At this time, we are only able to provide surface-level usage and design specifications for controls. We are working to make code for Tableau controls accessible to developers in the future.*
Copy file name to clipboardExpand all lines: docs/Style_Guidelines/ux_color.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Use of color is essential for communication. Color is one of the first visual el
16
16
17
17
## Color Principles
18
18
19
-
**Use colors with purpose and clarity.** Your color choices should highlight your extension's content, while also communicating its function. You should be able to justify the colors used on your extension: why did you choose that specific color, and what does it communicate to your user? Color is also an opportunity to showcase your brand. Learn more at **[Branding your Extension](4 - Branding your Extension.md)**.
19
+
**Use colors with purpose and clarity.** Your color choices should highlight your extension's content, while also communicating its function. You should be able to justify the colors used on your extension: why did you choose that specific color, and what does it communicate to your user? Color is also an opportunity to showcase your brand. Learn more at **[Branding your Extension](ux_branding.md)**.
20
20
21
21
**Less is more.** Refrain from using too many colors, which could blur the focus. Try to avoid using color applied to text, which can make words difficult to distinguish and decrease legibility.
Copy file name to clipboardExpand all lines: docs/Style_Guidelines/ux_fonts.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ We recommend that you use a **sans serif font family** in your extension. Here,
31
31
32
32
33
33
#### Benton Sans
34
-
Benton Sans Book is the default font for the Tableau UI elements. <i>Learn more about Tableau font colors at **[Color](6 - Color.md)**.</i>
34
+
Benton Sans Book is the default font for the Tableau UI elements. To learn more about Tableau font colors, see [Color](ux_color.md).
35
35
36
36
Other weight variations of Benton Sans should be used infrequently. For example, Benton Sans Medium is typically used for section titles in dialogs. Benton Sans Light and Book Italic are used in more specific cases like lightweight captions and should not be overused.
37
37
@@ -56,7 +56,7 @@ Using some of these common fonts that are likely available on your user's machin
56
56
57
57
58
58
###### Font Size
59
-
It is important to compensate for OS and device specific DPI and font rendering. Since these are alternative fonts that aren't directly used in Tableau, you may choose to use different font sizes and weights based on your extension's design needs.
59
+
It is important to compensate for OS and device specific DPI and font rendering. Since these are alternative fonts that aren't directly used in Tableau, you may choose to use different font sizes and weights based on your extension's design needs.
Copy file name to clipboardExpand all lines: docs/Style_Guidelines/ux_layout.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ It is common for extensions to take up a smaller size due to most of the functio
47
47
48
48
## Spacing
49
49
50
-
Specifications about spacing have been detailed in **[Controls and UI Patterns](Interaction Guidelines/3 - Controls and UI Patterns.md)** and **[Branding your Extension](4 - Branding your Extension.md)**.
50
+
Specifications about spacing have been detailed in **[Controls and UI Patterns](../Interaction_Guidelines/ux_controls_ui_patterns.md)** and **[Branding your Extension](ux_branding.md)**.
51
51
52
52
Here are some links to specific parts of your extension that you may need spacing guidance on:
Copy file name to clipboardExpand all lines: docs/trex_examples.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ The [Samples-Typescript](https://github.com/tableau/extensions-api/tree/master/S
70
70
71
71
Shows how you can use Tableau Viz to add visualizations to your dashboard extensions. This sample demonstrates the effects of different mark types and color palettes. For more information about Tableau Viz, see [Add Tableau Viz to Your Dashboard Extensions]({{site.baseurl}}/docs/trex_tableau_viz.html).
Shows how you can access the CSS formatting in the Tableau workbook and apply it to the HTML elements in your dashboard extension. Create a consistent look and feel across the extension and the dashboard.
Copy file name to clipboardExpand all lines: docs/trex_release-notes.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -642,9 +642,9 @@ Error: internal-error: permission-denied: Missing required permission to run get
642
642
Errors that are returned from the Extensions API are custom Tableau Error objects that extends the standard JavaScript error object.
643
643
644
644
645
-
The Extensions API wraps the standard error object with an `errorCode` property. Any time you encounter an error when you are developing your extension, you can look at this `errorCode` to determine the cause. See [Error Codes]({{site.baseurl}}/docs/enums/errorcodes.html).
645
+
The Extensions API wraps the standard error object with an `errorCode` property. Any time you encounter an error when you are developing your extension, you can look at this `errorCode` to determine the cause. See [Error Codes]({{site.baseurl}}/docs/enums/tableau.errorcodes.html).
646
646
647
-
For an example of how to handle error conditions, see the [UINamepace](https://github.com/tableau/extensions-api/tree/master/Samples/UINamepace?=target="_blank") sample. The sample shows how you could handle the error condition that occurs if a user dismisses a modal dialog box (`DialogClosedByUser`). The following snippet illustrates this pattern:
647
+
For an example of how to handle error conditions, see the [UINamespace](https://github.com/tableau/extensions-api/tree/main/Samples/UINamespace?=target="_blank") sample. The sample shows how you could handle the error condition that occurs if a user dismisses a modal dialog box (`DialogClosedByUser`). The following snippet illustrates this pattern:
0 commit comments