@atlassian/clientside-extensions-docs
Advanced tools
Comparing version 3.1.0 to 3.1.1-docs-1
@@ -7,3 +7,3 @@ --- | ||
subcategory: get-help | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: how-to | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: how-to | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: how-to | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: how-to | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: index | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -98,3 +98,3 @@ | ||
<td><code>@condition</code></td> | ||
<td><code>string | Conditions</code></td> | ||
<td><code>string | Condition, UrlReadingCondition</code></td> | ||
<td> | ||
@@ -101,0 +101,0 @@ <p>Defines one or multiple conditions that must be satisfied for the extension to be displayed.</p> |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -86,3 +86,3 @@ | ||
<td><code>@condition</code></td> | ||
<td><code>string | Conditions</code></td> | ||
<td><code>string | Condition, UrlReadingCondition</code></td> | ||
<td> | ||
@@ -89,0 +89,0 @@ <p>Defines one or multiple conditions that must be satisfied for the extension to be displayed.</p> |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -83,3 +83,3 @@ | ||
<td><code>@condition</code></td> | ||
<td><code>string | Conditions</code></td> | ||
<td><code>string | Condition, UrlReadingCondition</code></td> | ||
<td> | ||
@@ -86,0 +86,0 @@ <p>Defines one or multiple conditions that must be satisfied for the extension to be displayed.</p> |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -89,3 +89,3 @@ | ||
<td><code>@condition</code></td> | ||
<td><code>string | Conditions</code></td> | ||
<td><code>string | Condition, UrlReadingCondition</code></td> | ||
<td> | ||
@@ -92,0 +92,0 @@ <p>Defines one or multiple conditions that must be satisfied for the extension to be displayed.</p> |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -117,3 +117,3 @@ | ||
<td><code>@condition</code></td> | ||
<td><code>string | Conditions</code></td> | ||
<td><code>string | Condition, UrlReadingCondition</code></td> | ||
<td> | ||
@@ -120,0 +120,0 @@ <p>Defines one or multiple conditions that must be satisfied for the navigation link to be displayed.</p> |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -82,3 +82,3 @@ | ||
<td><code>@condition</code></td> | ||
<td><code>string | Conditions</code></td> | ||
<td><code>string | Condition, UrlReadingCondition</code></td> | ||
<td> | ||
@@ -85,0 +85,0 @@ <p>Defines one or multiple conditions that must be satisfied for the extension to be displayed.</p> |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: glossary | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: webpack | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -51,3 +51,3 @@ | ||
<td><code>@condition</code></td> | ||
<td><code>string | Conditions</code></td> | ||
<td><code>string | Condition, UrlReadingCondition</code></td> | ||
<td> | ||
@@ -268,3 +268,3 @@ <p>Defines one or multiple conditions that must be satisfied for the extension to be displayed.</p> | ||
The `@condition` annotation allows you to define one or multiple conditions that must be satisfied for the extension to be displayed. | ||
These conditions are a web-resource conditions evaluated in the server, and created with Java. | ||
These conditions are evaluated on the server and are implemented in Java. They are used for determining if the extension should be downloaded and rendered by the client. For compatibility reasons, the condition class needs to implement both `com.atlassian.plugin.web.Condition` and `com.atlassian.webresource.spi.condition.UrlReadingCondition` interfaces, and both implementations should yield the same result. | ||
@@ -284,2 +284,30 @@ For more information about the condition's usage please refer to the [examples of Web items documentation](https://developer.atlassian.com/server/framework/atlassian-sdk/web-section-plugin-module/#condition-and-conditions-elements) and check the [documentation of `conditionMap` option from `atlassian-webresource-webpack-plugin`](https://www.npmjs.com/package/atlassian-webresource-webpack-plugin#conditionmap-optional). | ||
```java | ||
public class RandomCondition implements Condition, UrlReadingCondition { | ||
// Condition implementation | ||
@Override | ||
public void init(Map<String, String> map) { | ||
} | ||
@Override | ||
public boolean shouldDisplay(Map<String, Object> map) { | ||
// ... | ||
} | ||
// UrlReadingCondition implementation | ||
@Override | ||
public void addToUrl(UrlBuilder urlBuilder) { | ||
// ... | ||
} | ||
/** | ||
* Needs to be the same result as {@link #shouldDisplay(Map)} | ||
*/ | ||
@Override | ||
public boolean shouldDisplay(QueryParams queryParams) { | ||
// ... | ||
} | ||
} | ||
``` | ||
### 6. Define a condition with parameters | ||
@@ -286,0 +314,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: webpack | ||
date: '2024-09-02' | ||
date: '2024-09-24' | ||
--- | ||
@@ -10,0 +10,0 @@ |
{ | ||
"name": "@atlassian/clientside-extensions-docs", | ||
"version": "3.1.0", | ||
"version": "3.1.1-docs-1", | ||
"description": "Holds the official documentation for Altassian Server client-side extensions API.", | ||
@@ -83,3 +83,3 @@ "license": "BSD-3-Clause", | ||
}, | ||
"gitHead": "1237d7f0c4fb95343d966f9cede9ea69d6b880a5" | ||
"gitHead": "9d4316afcce1a69967432de7ddf85c3440e50ea2" | ||
} |
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
2474232
1