primevue-mirror/doc/colors/OverviewDoc.vue

82 lines
3.1 KiB
Vue

<template>
<DocSectionText v-bind="$attrs">
<p>Colors are exported as CSS variables and used with the standard <i>var</i> syntax such as <i>var(--text-color)</i>. Following is the list of general variables used in a theme.</p>
</DocSectionText>
<div className="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>--text-color</td>
<td>Font text color.</td>
</tr>
<tr>
<td>--text-secondary-color</td>
<td>Muted font text color with a secondary level.</td>
</tr>
<tr>
<td>--primary-color</td>
<td>Primary color of the theme.</td>
</tr>
<tr>
<td>--primary-color-text</td>
<td>Text color when background is primary color.</td>
</tr>
<tr>
<td>--font-family</td>
<td>Font family of the theme.</td>
</tr>
<tr>
<td>--inline-spacing</td>
<td>Spacing between to adjacent items.</td>
</tr>
<tr>
<td>--border-radius</td>
<td>Common border radius of elements.</td>
</tr>
<tr>
<td>--focus-ring</td>
<td>Box shadow of a focused element.</td>
</tr>
<tr>
<td>--mask-bg</td>
<td>Background of an overlay mask.</td>
</tr>
<tr>
<td>--highlight-bg</td>
<td>Background of a highlighted element.</td>
</tr>
<tr>
<td>--highlight-text-color</td>
<td>Text color of a highlighted element.</td>
</tr>
</tbody>
</table>
</div>
<div class="card flex justify-content-center gap-3">
<div :style="{ backgroundColor: 'var(--highlight-bg)', color: 'var(--highlight-text-color)', borderRadius: 'var(--border-radius)', padding: '3rem' }">Highlighted Item</div>
<div :style="{ backgroundColor: 'var(--primary-color)', color: 'var(--primary-color-text)', borderRadius: 'var(--border-radius)', padding: '3rem' }">Primary Color</div>
</div>
<DocSectionCode :code="code" hideToggleCode import hideCodeSandbox hideStackBlitz />
</template>
<script>
export default {
data() {
return {
code: {
basic: `
<div style="backgroundColor: var(--highlight-bg), color: var(--highlight-text-color), borderRadius: var(--border-radius), padding: 3rem">Highlighted Item</div>
<div style="backgroundColor: var(--primary-color), color: var(--primary-color-text), borderRadius: var(--border-radius), padding: 3rem">Primary Color</div>`
}
};
}
};
</script>