Skip to content

Commit 9fbe8df

Browse files
committed
Heading improvements and consistency
1 parent 4fd9b15 commit 9fbe8df

File tree

5 files changed

+38
-22
lines changed

5 files changed

+38
-22
lines changed

CHANGELOG.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ This release contains a large number of changes. It lists only the major changes
1717
- `Processes`
1818
- `SearchableList`
1919
- `ServiceType`
20+
- `BillingPlans`:
21+
- New properties `heading` and `headingTag`
22+
- Shows a heading by default
2023
- `Description`: New property `allowHTML` to enable HTML rendering embedded in Markdown files
2124
- `FileFormats`, `ServiceTypes` and `UdfRuntimes`:
2225
- New properties `searchTerm`, `sort`, `allowExpand`, `heading`
@@ -25,7 +28,7 @@ This release contains a large number of changes. It lists only the major changes
2528
- Expands on click to show details about the file format / service type / UDF runtime
2629
- `ObjectTree`: New property `collapseAfter` to set the number of array elements or object properties to show by default. This can now be used to show all, too.
2730
- `SupportedFeatures`:
28-
- New property `heading`
31+
- New properties `heading` and `headingTag`
2932
- Shows a heading by default
3033
- `UdfRuntime`: Added slots `title`, `badges` and `before-description`
3134

components/BillingPlans.vue

+17-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
<template>
22
<section class="vue-component billing-plans">
3-
<div class="billing-currency">
4-
<template v-if="currency !== null">
5-
<strong>Currency:</strong> {{ currency }}
6-
</template>
7-
<template v-else>No billing information provided.</template>
8-
</div>
9-
<h4>Plans</h4>
3+
<component v-if="heading" :is="headingTag">{{ heading }}</component>
4+
<strong>Plans</strong>
105
<ul v-if="currency !== null && plans.length">
116
<li v-for="(plan, key) in plans" :key="key">
127
<strong class="plan-name">
@@ -21,7 +16,13 @@
2116
<Description v-if="plan.description" :description="plan.description" :compact="true" />
2217
</li>
2318
</ul>
24-
<div v-else>No plans available.</div>
19+
<p v-else>No plans available.</p>
20+
<div class="billing-currency">
21+
<template v-if="currency !== null">
22+
<strong>Currency:</strong> {{ currency }}
23+
</template>
24+
<template v-else>No billing information provided.</template>
25+
</div>
2526
</section>
2627
</template>
2728

@@ -37,6 +38,14 @@ export default Utils.enableHtmlProps({
3738
billing: {
3839
type: Object,
3940
default: () => ({})
41+
},
42+
heading: {
43+
type: String,
44+
default: 'Billing'
45+
},
46+
headingTag: {
47+
type: String,
48+
default: 'h2'
4049
}
4150
},
4251
computed: {

components/Capabilities.vue

+2-6
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,8 @@
1010
</span></div>
1111
</section>
1212
<Description v-if="capabilities.description" :description="capabilities.description" />
13-
<h3>Supported functionalities</h3>
14-
<SupportedFeatures :endpoints="capabilities.endpoints" />
15-
<template v-if="capabilities.billing">
16-
<h3>Billing</h3>
17-
<BillingPlans :billing="capabilities.billing" />
18-
</template>
13+
<SupportedFeatures :endpoints="capabilities.endpoints" headingTag="h3" />
14+
<BillingPlans v-if="capabilities.billing" :billing="capabilities.billing" headingTag="h3" />
1915
<LinkList :links="capabilities.links" heading="More information" headingTag="h3" />
2016
</div>
2117
</template>

components/JsonSchema.vue

+9-5
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,24 @@
33
<template v-if="visible">
44
<div v-if="isProcessGraph" class="schemaProcessGraph">
55
<div class="process-graph-parameters">
6-
<p class="schema-attrs">{{ formatKey('type') }}: <span class="data-type">process</span></p>
6+
<p class="schema-attrs">{{ formatKey('type') }}: <span class="data-type">child process</span></p>
7+
<p title="The parameters that can be used in the process.">
8+
<strong>Child Process Parameters:</strong>
9+
</p>
710
<template v-if="hasParameters">
8-
<p><strong>These parameters are passed to the process:</strong></p>
911
<ProcessParameter v-for="(param, i) in schema.parameters" :key="i" :parameter="param" :processUrl="processUrl" />
1012
</template>
11-
<strong v-else>No parameters are passed to the process.</strong>
13+
<p v-else>No parameters defined.</p>
14+
<p title="Describes what must be returned by the process.">
15+
<strong>Child Process Return Value:</strong>
16+
</p>
1217
<template v-if="hasReturns">
13-
<p><strong>The process must return:</strong></p>
1418
<Description v-if="schema.returns.description" :description="schema.returns.description" :processUrl="processUrl" />
1519
<div class="json-schema-container" v-if="schema.returns.schema">
1620
<JsonSchema :schema="schema.returns.schema" />
1721
</div>
1822
</template>
19-
<strong v-else>Not defined by the process.</strong>
23+
<p v-else>No constraints defined.</p>
2024
</div>
2125
</div>
2226
<div v-else-if="showRow('object')" class="schemaObjectElement">

components/SupportedFeatures.vue

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<template>
22
<div class="vue-component features">
3-
<h2 v-if="heading">
3+
<component v-if="heading" :is="headingTag">
44
{{ heading }}
55
({{ supportedFeatureCount }}/{{ totalCount }})
6-
</h2>
6+
</component>
77
<ul>
88
<li v-for="(status, feature) in supportedFeatures" :key="feature">
99
<span v-text="status.icon" :class="status.className" :title="status.tooltip"></span> {{ feature }}
@@ -26,6 +26,10 @@ export default Utils.enableHtmlProps({
2626
heading: {
2727
type: String,
2828
default: 'Supported Functionalities'
29+
},
30+
headingTag: {
31+
type: String,
32+
default: 'h2'
2933
}
3034
},
3135
data() {

0 commit comments

Comments
 (0)