Skip to content

Commit

Permalink
Improvements Bootstrap docs (#87)
Browse files Browse the repository at this point in the history
* fix: typos Bootstrap docs page

* fix: improve structure Bootstrap docs page

* fix: add bootstrap4 and bootstrap5 to configuration docs
  • Loading branch information
sidneygijzen committed Feb 11, 2024
1 parent e5826ae commit 99767c1
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 26 deletions.
2 changes: 1 addition & 1 deletion packages/docs/src/guide/configuration/composition-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ useGrid(config: string)
The value can either be a string literal, with one of the supported UI frameworks:
```ts
'tailwind' | 'bootstrap' | 'bulma' | 'foundation' | 'materialize' | 'semanticUi'
'tailwind' | 'bootstrap' | 'bootstrap4' | 'bootstrap5' | 'bulma' | 'foundation' | 'materialize' | 'semanticUi'
```
or an object that specifies a custom grid:
Expand Down
4 changes: 2 additions & 2 deletions packages/docs/src/guide/configuration/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Config can be either:
- a string, with one of the supported UI frameworks:
```ts
'tailwind' | 'bootstrap' | 'bulma' | 'foundation' | 'materialize' | 'semanticUi'
'tailwind' | 'bootstrap' | 'bootstrap4' | 'bootstrap5' | 'bulma' | 'foundation' | 'materialize' | 'semanticUi'
```
- an object, with the following signature:
Expand All @@ -32,4 +32,4 @@ Config can be either:
}
```
Please refer to [Composition API configuration](/guide/configuration/composition-api) for the signatures of each property.
Please refer to [Composition API configuration](/guide/configuration/composition-api) for the signatures of each property.
51 changes: 28 additions & 23 deletions packages/docs/src/guide/frameworks/bootstrap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ editLink: true

To use Bootstrap as your UI framework, simply pass it to the configuration

### Boostrap 3
## Bootstrap 3
```js
import { useGrid } from 'vue-screen'

Expand All @@ -32,7 +32,19 @@ import VueScreen from 'vue-screen'
createApp().use(VueScreen, 'bootstrap') // Bootstrap 3 grid
```

### Boostrap 4
Your grid object will contain the following properties:

```ts
{
xs: boolean,
sm: boolean,
md: boolean,
lg: boolean,
breakpoint: string | null // the current breakpoint
}
```

## Bootstrap 4
```js
import { useGrid } from 'vue-screen'

Expand All @@ -45,7 +57,20 @@ import VueScreen from 'vue-screen'
createApp().use(VueScreen, 'bootstrap4')
```

### Boostrap 5
Your grid object will contain the following properties:

```ts
{
xs: boolean,
sm: boolean,
md: boolean,
lg: boolean,
xl: boolean
breakpoint: string | null // the current breakpoint
}
```

## Bootstrap 5
```js
import { useGrid } from 'vue-screen'

Expand All @@ -61,26 +86,6 @@ createApp().use(VueScreen, 'bootstrap5')
Your grid object will contain the following properties:

```ts
// Bootstrap 3
{
xs: boolean,
sm: boolean,
md: boolean,
lg: boolean,
breakpoint: string | null // the current breakpoint
}

// Bootstrap 4
{
xs: boolean,
sm: boolean,
md: boolean,
lg: boolean,
xl: boolean
breakpoint: string | null // the current breakpoint
}

// Bootstrap 5
{
xs: boolean,
sm: boolean,
Expand Down

0 comments on commit 99767c1

Please sign in to comment.