Skip to content

Commit 23a7439

Browse files
Documentation Updates (#480)
* Documentation Fixes - Documentation fixes Signed-off-by: Vedangi Mittal <[email protected]> * Fixed code snippet - Fixed code snippet --------- Signed-off-by: Vedangi Mittal <[email protected]>
1 parent 6099a81 commit 23a7439

File tree

14 files changed

+77
-36
lines changed

14 files changed

+77
-36
lines changed

docs/.vitepress/components/colors/reds.vue

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,14 @@
2121
</template>
2222

2323
<script setup>
24+
import { ref } from 'vue';
25+
2426
const colors = ref([
25-
{
26-
variable: 'red-500',
27-
hex: '#da1416'
28-
}
29-
])
27+
{
28+
variable: 'red-500',
29+
hex: '#da1416'
30+
}
31+
]);
3032
</script>
3133

3234
<style lang="scss" scoped>

docs/.vitepress/components/colors/theme.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
<script setup>
2424
import { ref } from 'vue';
25+
2526
const themeColors = ref([
2627
{
2728
name: "primary",

docs/.vitepress/components/colors/yellows.vue

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@
2020
</div>
2121
</template>
2222

23-
<script>
23+
<script setup>
24+
import { ref } from 'vue';
25+
2426
const colors = ref([
2527
{
2628
variable: 'yellow-500',

docs/.vitepress/theme/index.js

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import DefaultTheme from 'vitepress/theme'
2+
import All from '../components/colors/all.vue'
3+
import Blues from '../components/colors/blues.vue'
4+
import Grays from '../components/colors/grays.vue'
5+
import Greens from '../components/colors/greens.vue'
6+
import Reds from '../components/colors/reds.vue'
7+
import Yellows from '../components/colors/yellows.vue'
8+
import Theme from '../components/colors/theme.vue'
9+
10+
export default {
11+
...DefaultTheme,
12+
enhanceApp({ app }) {
13+
app.component('colors-all', All)
14+
app.component('colors-blues', Blues)
15+
app.component('colors-grays', Grays)
16+
app.component('colors-greens', Greens)
17+
app.component('colors-reds', Reds)
18+
app.component('colors-yellows', Yellows)
19+
app.component('colors-theme', Theme)
20+
}
21+
}

docs/customization/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,6 @@ You might notice that there is an HTML element, `<h2>`, used in the example. Thi
366366
[Learn more about single file components](https://vuejs.org/v2/guide/single-file-components.html)
367367

368368
Customization of the application requires knowledge of Sass and CSS. It also
369-
will require becoming familiar with the Bootstrap and Bootstrap-Vue component
369+
will require becoming familiar with the Bootstrap and Bootstrap-Vue-next component
370370
libraries. This section outlines the global options and variables that can be
371371
removed or updated to meet organizational brand guidelines.

docs/customization/theme.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ UI `theme-color` map has the same keys as the Bootstrap `theme-color` map with
140140
custom values.
141141

142142
The `theme-color` map is used heavily throughout the application. The
143-
Bootstrap-Vue components `variant` prop also utilizes the `theme-color` map.
143+
Bootstrap-Vue-next components `variant` prop also utilizes the `theme-color` map.
144144
This map is the key to customizing the application's color palette. Take a look
145145
at the [color guidelines](/guide/guidelines/colors) to better understand default
146146
theme-colors map.
@@ -158,17 +158,12 @@ gray variable values.
158158
[Learn more about Bootstrap
159159
colors](https://getbootstrap.com/docs/4.0/getting-started/theming/#color)
160160

161-
<!-- ### Bootstrap Color Functions
162-
- `color('<color map key>)`
163-
- `theme-color('<theme color map key>)`
164-
- `gray('<gray color palette key'>)` -->
165-
166161

167162
#### Example
168163
```SCSS
169164
.some-selector {
170165
color: color("blue");
171-
background: theme-color("light");
166+
background-color: $light;
172167
border: 1px solid $gray-900;
173168
}
174169
```

docs/guide/coding-standards/accessibility.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ The OpenBMC Web UI developers should test their development pages using one of
4141
the tools listed in the tools section below. If using Chrome, the Lighthouse
4242
application comes bundled with the browser and also includes testing for
4343
performance and best practices. If there is an issue that is created when using
44-
a Bootstrap-Vue component, we can [create an issue in the Bootstrap-vue
45-
repo](https://github.com/bootstrap-vue/bootstrap-vue/issues/new/choose).
46-
Contributing to the Bootstrap-Vue open-source library, when possible, is
44+
a Bootstrap-Vue-next component, we can [create an issue in the Bootstrap-vue-next
45+
repo](https://github.com/bootstrap-vue-next/bootstrap-vue-next/issues/new/choose).
46+
Contributing to the Bootstrap-Vue-next open-source library, when possible, is
4747
strongly encouraged.
4848

4949
## Tools

docs/guide/components/file-upload/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# FormFile
22

3-
`FormFile` is a custom component wrapper around the Bootstrap-vue Form File
3+
`FormFile` is a custom component wrapper around the Bootstrap-vue-next Form File
44
component. The purpose of this component is to upload files to the BMC.
55

66
To use this component:

docs/guide/components/info-tooltip/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# InfoTooltip
22

3-
The `InfoTooltip` is a custom component that uses a Bootstrap-vue tooltip with
3+
The `InfoTooltip` is a custom component that uses a Bootstrap-vue-next tooltip with
44
an info icon. This custom component requires a title property containing the
55
tooltip text to display to the user.
66

docs/guide/components/table/index.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ columns and add the following props to the `<BTable>` component:
9696
:fields="fields"
9797
/>
9898
</template>
99+
99100
<script setup>
100101
import { ref } from 'vue';
101102
@@ -124,9 +125,7 @@ const fields = ref([
124125

125126
To add an expandable row in the table, add a column for the expand button in the
126127
fields array. Include the tdClass `table-row-expand` to ensure icon rotation is
127-
handled. Use the built in [cell
128-
slot](https://bootstrap-vue.org/docs/components/table#comp-ref-BTable-slots) to
129-
target the expand button column and add a button with the chevron icon.
128+
handled.
130129

131130
Include the
132131
[useTableRowExpandComposable](https://github.com/ibm-openbmc/webui-vue/blob/1060-vue3/src/components/Composables/useTableRowExpandComposable.js).
@@ -175,6 +174,7 @@ format the expanded row content. The slot has access to the row `item` property.
175174
</template>
176175
</BTable>
177176
</template>
177+
178178
<script setup>
179179
import { ref } from 'vue';
180180
import IconChevron from '@carbon/icons-vue/es/chevron--down/20';
@@ -253,6 +253,7 @@ if there are no search matches.
253253
/>
254254
</BContainer>
255255
</template>
256+
256257
<script setup>
257258
import { ref, computed } from 'vue';
258259
import Search from '@/components/Global/Search';
@@ -312,6 +313,7 @@ component will emit a `@click-table-action` with the event value.
312313
</template>
313314
</BTable>
314315
</template>
316+
315317
<script>
316318
import { ref } from 'vue';
317319
import IconDelete from '@carbon/icons-vue/es/trash-can/20';
@@ -390,6 +392,7 @@ from the useTableFilterComposable to show the filtered table data.
390392
/>
391393
</b-container>
392394
</template>
395+
393396
<script setup>
394397
import { ref, computed } from 'vue';
395398
import TableFilter from '@/components/Global/TableFilter.vue';
@@ -491,6 +494,7 @@ To add table batch actions:
491494
</BTable>
492495
</b-container>
493496
</template>
497+
494498
<script>
495499
import { ref } from 'vue';
496500
import TableToolbar from '@/components/Global/TableToolbar.vue';
@@ -602,6 +606,7 @@ To add table pagination:
602606
</BRow>
603607
</BContainer>
604608
</template>
609+
605610
<script>
606611
import { ref } from 'vue';
607612
import usePaginationComposable from '@/components/Composables/usePaginationComposable';

0 commit comments

Comments
 (0)