Space

Even though we have Divider, but sometimes we need more than one to split the elements apart, so we stack each elements upon Divider, but doing so not only makes our code ugly but also makes it difficult to maintain. Space is this kind of component provides us both productivity and elegance.

Basic usage

The basic use case is using this component to provide unified space between each components

Using Space to provide space

Card name

List item 1

List item 2

List item 3

List item 4

Card name

List item 1

List item 2

List item 3

List item 4

Card name

List item 1

List item 2

List item 3

List item 4

---

<template>
  <b-space wrap>
    <b-card v-for="i in 3" :key="i" bordered class="w-280px">
      <template #header>
        <div class="flex justify-between items-center">
          <h4>Card name</h4>
          <b-button ghost small text>Operation</b-button>
        </div>
      </template>
      <div v-for="o in 4" :key="o" :class="{ 'mt-4': o > 1 }">
        {{ 'List item ' + o }}
      </div>
    </b-card>
  </b-space>
</template>

Vertical layout

Using direction attribute to control the layout, we use flex-direction to implement this.

We also provide vertical layout.

Card name

List item 1

List item 2

List item 3

List item 4

Card name

List item 1

List item 2

List item 3

List item 4

Card name

List item 1

List item 2

List item 3

List item 4

---

<template>
  <b-space vertical>
    <b-card v-for="i in 3" :key="i" bordered class="w-280px">
      <template #header>
        <div class="flex justify-between items-center">
          <h4>Card name</h4>
          <b-button ghost small text>Operation</b-button>
        </div>
      </template>
      <div v-for="o in 4" :key="o" :class="{ 'mt-4': o > 1 }">
        {{ 'List item ' + o }}
      </div>
    </b-card>
  </b-space>
</template>

Control the size of the space

Control the space size via size API.

You can set the size with built-in sizes small, default, large, these size coresponds to 16px, 24px, 32px. The default size is small, A.K.A. 8px

You can also using customized size to override it. Refer to the next part.

smalldefaultlarge

Card name

List item 1

List item 2

List item 3

List item 4

Card name

List item 1

List item 2

List item 3

List item 4

---

<template>
  <div>
    <b-radio-group v-model="size" small class="mb-4">
      <b-radio-button
        v-for="s in ['small', 'default', 'large']"
        :key="s"
        :value="s"
        :label="s"
      />
    </b-radio-group>
  </div>
  <b-space wrap :size="size">
    <b-card v-for="i in 2" :key="i" bordered class="w-280px">
      <template #header>
        <div class="flex justify-between">
          <h4>Card name</h4>
          <b-button ghost small text>Operation</b-button>
        </div>
      </template>
      <div v-for="o in 4" :key="o" :class="{ 'mt-4': o > 1 }">
        {{ 'List item ' + o }}
      </div>
    </b-card>
  </b-space>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const size = ref('default')
</script>

Customized Size

Sometimes built-in sizes could not meet the business needs, we can use custom size (number type) to control the space between items.

Card name

List item 1

List item 2

List item 3

List item 4

Card name

List item 1

List item 2

List item 3

List item 4

---

<template>
  <b-slider v-model="size" :step="4" class="mb-4" />
  <b-space wrap :gutter="size * 0.25">
    <b-card v-for="i in 2" :key="i" bordered class="w-240px">
      <template #header>
        <div class="flex justify-between items-center">
          <h4>Card name</h4>
          <b-button ghost small text>Operation</b-button>
        </div>
      </template>
      <div v-for="o in 4" :key="o" :class="{ 'mt-4': o > 0 }">
        {{ 'List item ' + o }}
      </div>
    </b-card>
  </b-space>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const size = ref(16)
</script>

TIP

Do not use Space with components that depend on ancestor width (height), e.g. Slider, in this case when you drag the trigger button the bar will grow which causes misplacement between cursor and trigger button.

Auto wrapping

When in horizontal mode, using wrap (bool type) to control auto wrapping behavior.

Using wrap to control line wrap

---

<template>
  <b-space wrap>
    <div v-for="i in 20" :key="i">
      <b-button ghost small>Text button</b-button>
    </div>
  </b-space>
</template>

Spacer

Sometimes we want something more than blank space, so we have (spacer) to help us.

Literal type spacer

|

---

<template>
  <b-space spacer="|">
    <div v-for="i in 2" :key="i">
      <b-button small> Button {{ i }} </b-button>
    </div>
  </b-space>
</template>

Spacer can also be VNode

---

<template>
  <b-space :spacer="spacer" :gutter="1">
    <div v-for="i in 2" :key="i">
      <b-button small> Button {{ i }} </b-button>
    </div>
  </b-space>
</template>

<script lang="ts" setup>
import { h } from 'vue'
import { BDivider } from 'bigin-ui'

const spacer = h(BDivider, { vertical: true, class: 'h-5' })
</script>

Alignment

Setting this attribute can adjust the alignment of child nodes, the desirable value can be found at align-items.

Using alignment

Default

header

body

Start

header

body

End

header

body

---

<template>
  <b-space>
    <p>Default</p>
    <b-button small>button</b-button>
    <b-card bordered>
      <template #header><h4>header</h4></template>
      <p>body</p>
    </b-card>
  </b-space>
  <b-divider />
  <b-space alignment="flex-start">
    <p>Start</p>
    <b-button small>button</b-button>
    <b-card bordered>
      <template #header><h4>header</h4></template>
      <p>body</p>
    </b-card>
  </b-space>
  <b-divider />
  <b-space alignment="flex-end">
    <p>End</p>
    <b-button small>button</b-button>
    <b-card bordered>
      <template #header><h4>header</h4></template>
      <p>body</p>
    </b-card>
  </b-space>
</template>

Fill the container

Through the fill (Boolean type) parameter, you can control whether the child node automatically fills the container.

In the following example, when set to fill, the width of the child node will automatically adapt to the width of the container.

Use fill to automatically fill the container with child nodes

You can also use the fillRatio parameter to customize the filling ratio. The default value is 100, which represents filling based on the width of the parent container at 100%.

It should be noted that the expression of horizontal layout and vertical layout is slightly different, the specific effect can be viewed in the following example.

Use fillRatio to customize the fill ratio

Fill

Card name

List item 1

List item 2

List item 3

List item 4

Card name

List item 1

List item 2

List item 3

List item 4

---

<template>
  <div class="flex items-center mb-4">
    <p class="mr-2">Fill</p>
    <b-switch v-model="fill" />
  </div>

  <b-space wrap :fill="fill" :fill-ratio="50" class="w-full">
    <b-card v-for="i in 2" :key="i" bordered class="min-w-280px">
      <template #header>
        <div class="flex justify-between items-center">
          <h4>Card name</h4>
          <b-button ghost small text>Operation</b-button>
        </div>
      </template>
      <div v-for="o in 4" :key="o" :class="{ 'mt-4': o > 0 }">
        {{ 'List item ' + o }}
      </div>
    </b-card>
  </b-space>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const fill = ref(true)
</script>

Space Attributes

Name	Description	Type	Available value	Default
alignment	Controls the alignment of items	string	align-items	center
vertical	Vertical alignment	boolean	-	false
direction	Placement direction	string	vertical/horizontal	horizontal
gutter	Gutter same as Row	number	-	-
style	Extra style rules	string / Array<Object | String> / Object	-	-
spacer	Spacer	string / number / VNode	-	-
size	Spacing size	string / number / [number, number]	-	small
wrap	Auto wrapping	boolean	true / false	false
fill	Whether to fill the container	boolean	true / false	false
fill-ratio	Ratio of fill	number	-	100

Space Slot

name	description
default	Items to be spaced