Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(comp: space): replace gap prop with size #670

Merged
merged 1 commit into from
Dec 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion packages/components/back-top/style/index.less
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,19 @@
background-color: @back-top-background-color;
width: @back-top-width;
height: @back-top-height;
color: @color-white;
color: @back-top-color;
danranVm marked this conversation as resolved.
Show resolved Hide resolved
display: flex;
align-items: center;
justify-content: center;
font-size: @back-top-font-size;
border-radius: @back-top-border-radius;
box-shadow: @back-top-box-shadow;
cursor: pointer;

&:hover {
background-color: @back-top-background-hover-color;
color: @back-top-hover-color;
}
}

@media screen and (min-width: @screen-lg) and (max-width: @screen-lg-max) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,10 @@

@back-top-bottom: 50px;

@back-top-color: @color-white;
@back-top-hover-color: @color-white;
@back-top-background-color: @color-primary;
@back-top-background-hover-color: @color-primary;


@back-top-box-shadow: 0 2px 8px 0 rgba(30,35,43,0.12);
2 changes: 1 addition & 1 deletion packages/components/config/src/defaultConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ const divider: DividerConfig = {
type: 'horizontal',
}

const space: SpaceConfig = { gap: 8, wrap: true }
const space: SpaceConfig = { size: 'sm', wrap: true }

const row: RowConfig = { wrap: true }

Expand Down
3 changes: 2 additions & 1 deletion packages/components/config/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import type { NotificationPlacement, NotificationType } from '@idux/components/n
import type { PaginationItemRenderFn, PaginationSize, PaginationTotalRenderFn } from '@idux/components/pagination'
import type { ProgressFormat, ProgressSize } from '@idux/components/progress'
import type { ResultStatus } from '@idux/components/result'
import type { SpaceSize } from '@idux/components/space'
import type { SpinSize, SpinTipAlignType } from '@idux/components/spin'
import type { StepperSize } from '@idux/components/stepper'
import type { TableColumnAlign, TableColumnSortOrder, TablePaginationPosition, TableSize } from '@idux/components/table'
Expand Down Expand Up @@ -55,7 +56,7 @@ export interface DividerConfig {
}

export interface SpaceConfig {
gap: number | string | [number | string, number | string]
size: number | string | [number | string, number | string] | SpaceSize
wrap: boolean
}

Expand Down
38 changes: 28 additions & 10 deletions packages/components/space/__tests__/space.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,25 @@ describe('Space', () => {
expect(wrapper.classes()).toContain('ix-space-vertical')
})

test('gap work', async () => {
test('block work', async () => {
const wrapper = SpaceMount({
props: {
direction: 'vertical',
},
})

expect(wrapper.classes()).not.toContain('ix-space-block')

await wrapper.setProps({ block: true })

expect(wrapper.classes()).toContain('ix-space-block')

await wrapper.setProps({ direction: 'horizontal' })

expect(wrapper.classes()).not.toContain('ix-space-block')
})

test('size work', async () => {
const wrapper = SpaceMount()

const wrapperElement = wrapper.element as HTMLElement
Expand All @@ -68,7 +86,7 @@ describe('Space', () => {
expect(itemElements[2].style.marginRight).toBe('')
expect(itemElements[2].style.paddingBottom).toEqual('8px')

await wrapper.setProps({ gap: 16 })
await wrapper.setProps({ size: 'md' })

expect(wrapperElement.style.marginBottom).toBe('-16px')
expect(itemElements[0].style.marginRight).toBe('16px')
Expand All @@ -78,17 +96,17 @@ describe('Space', () => {
expect(itemElements[2].style.marginRight).toBe('')
expect(itemElements[2].style.paddingBottom).toEqual('16px')

await wrapper.setProps({ gap: `24px` })
await wrapper.setProps({ size: 30 })

expect(wrapperElement.style.marginBottom).toBe('-24px')
expect(itemElements[0].style.marginRight).toBe('24px')
expect(itemElements[0].style.paddingBottom).toEqual('24px')
expect(itemElements[1].style.marginRight).toBe('24px')
expect(itemElements[1].style.paddingBottom).toEqual('24px')
expect(wrapperElement.style.marginBottom).toBe('-30px')
expect(itemElements[0].style.marginRight).toBe('30px')
expect(itemElements[0].style.paddingBottom).toEqual('30px')
expect(itemElements[1].style.marginRight).toBe('30px')
expect(itemElements[1].style.paddingBottom).toEqual('30px')
expect(itemElements[2].style.marginRight).toBe('')
expect(itemElements[2].style.paddingBottom).toEqual('24px')
expect(itemElements[2].style.paddingBottom).toEqual('30px')

await wrapper.setProps({ gap: [8, 16] })
await wrapper.setProps({ size: [8, 16] })

expect(wrapperElement.style.marginBottom).toBe('-16px')
expect(itemElements[0].style.marginRight).toBe('8px')
Expand Down
2 changes: 1 addition & 1 deletion packages/components/space/demo/Basic.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<template>
<IxSpace>
Space
danranVm marked this conversation as resolved.
Show resolved Hide resolved
space:
<IxButton mode="primary">Button</IxButton>
<IxButton>Button</IxButton>
<IxButton danger>Button</IxButton>
Expand Down
17 changes: 17 additions & 0 deletions packages/components/space/demo/CustomSize.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<template>
<IxSpace direction="vertical" block>
<IxSlider v-model:value="size" :tooltip-visible="true" :min="0" :max="50"></IxSlider>
<IxSpace :size="size">
space:
<IxButton mode="primary">Button</IxButton>
<IxButton>Button</IxButton>
</IxSpace>
</IxSpace>
</template>

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

const size = ref(8)
</script>
<style scoped></style>
2 changes: 1 addition & 1 deletion packages/components/space/demo/Direction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ title:

相邻组件垂直间距。

可以设置 `width: 100%` 独占一行。
可以设置 `block` 独占一行。
4 changes: 2 additions & 2 deletions packages/components/space/demo/Direction.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<template>
<IxSpace direction="vertical">
Space
<IxSpace direction="vertical" block>
space:
<IxButton mode="primary">Button</IxButton>
<IxButton>Button</IxButton>
</IxSpace>
Expand Down
16 changes: 0 additions & 16 deletions packages/components/space/demo/Gap.vue

This file was deleted.

10 changes: 10 additions & 0 deletions packages/components/space/demo/Size.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
order: 2
title:
zh: 尺寸
en: Size
---

## zh

提供了`sm``md``lg`三种间隔尺寸
20 changes: 20 additions & 0 deletions packages/components/space/demo/Size.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<template>
<IxSpace direction="vertical">
<IxRadioGroup v-model:value="size">
<IxRadio value="sm">小</IxRadio>
<IxRadio value="md">正常</IxRadio>
<IxRadio value="lg">大</IxRadio>
</IxRadioGroup>
<IxSpace :size="size">
space:
<IxButton mode="primary">Button</IxButton>
<IxButton>Button</IxButton>
</IxSpace>
</IxSpace>
</template>

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

const size = ref('md')
</script>
7 changes: 2 additions & 5 deletions packages/components/space/docs/Index.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,12 @@ cover:
| 属性 | 说明 | 类型 | 默认值 | 全局配置 | 备注 |
| --- | --- | --- | --- | --- | --- |
| `align` | 对齐方式 | `'start' \| 'center' \| 'end' \| 'baseline'` | - | - | `horizontal` 时,默认为 `center` |
| `block` | 将内容宽度调整为自适应其父元素的宽度 | `boolean` | - | - | 仅在`direction`为 `vertical` 时生效 |
| `direction` | 间距方向 | `'horizontal' \| 'vertical'` | `'horizontal'` | - | - |
| `gap` | 间距大小 | `number \| string \| [number \| string, number \| string]` | `8` | ✅ | 默认使用 [`flex` 布局的 `gap` 属性](https://developer.mozilla.org/zh-CN/docs/Web/CSS/gap), 如果遇到不兼容的浏览器,会使用 `margin` 代替。 如果传入一个数组,那么分别表示 `[rowGap, columnGap]` |
| `size` | 间距大小 | `number \| string \| [number \| string, number \| string] \| 'sm' \| 'md' \| 'lg'` | `sm` | ✅ | 默认使用 [`flex` 布局的 `gap` 属性](https://developer.mozilla.org/zh-CN/docs/Web/CSS/gap), 如果遇到不兼容的浏览器,会使用 `margin` 代替。 如果传入一个数组,那么分别表示 `[rowGap, columnGap]` |
| `split` | 设置间隔分割符 | `string \| #split` | - | - | - |
| `wrap` | 是否自动换行 | `boolean` | `true` | ✅ | - |

```ts
export type SpaceSize = 'sm' | 'md' | 'lg' | number
```

#### SpaceSlots

| 属性 | 说明 | 参数类型 | 备注 |
Expand Down
1 change: 1 addition & 0 deletions packages/components/space/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ export type {
SpacePublicProps as SpaceProps,
SpaceAlign,
SpaceDirection,
SpaceSize,
} from './src/types'
16 changes: 12 additions & 4 deletions packages/components/space/src/Space.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
*/

import type { SpaceProps } from './types'
import type { FormSize } from '@idux/components/form'
import type { ComputedRef, Slots, VNode } from 'vue'

import { computed, defineComponent, normalizeClass } from 'vue'
Expand All @@ -18,6 +19,12 @@ import { spaceProps } from './types'

const flexGapSupported = supportsFlexGap()

const defaultSizeMap = {
sm: '8px',
md: '16px',
lg: '24px',
} as const

export default defineComponent({
name: 'IxSpace',
props: spaceProps,
Expand All @@ -36,17 +43,18 @@ export default defineComponent({
})

const mergedGaps = computed(() => {
const { gap = config.gap } = props
const gaps = Array.isArray(gap) ? gap : [gap, gap]
return gaps.map(gap => convertCssPixel(gap))
const { size = config.size } = props
const sizes = Array.isArray(size) ? size : [size, size]
return sizes.map(size => defaultSizeMap[size as FormSize] || convertCssPixel(size))
})

const classes = computed(() => {
const { direction } = props
const { block, direction } = props
const align = mergedAlign.value
const prefixCls = mergedPrefixCls.value
return normalizeClass({
[prefixCls]: true,
[`${prefixCls}-block`]: block && direction === 'vertical',
[`${prefixCls}-align-${align}`]: align,
[`${prefixCls}-${direction}`]: true,
[`${prefixCls}-wrap`]: wrap.value,
Expand Down
10 changes: 9 additions & 1 deletion packages/components/space/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,25 @@
*/

import type { IxInnerPropTypes, IxPublicPropTypes } from '@idux/cdk/utils'
import type { FormSize } from '@idux/components/form'
import type { DefineComponent, HTMLAttributes } from 'vue'

import { IxPropTypes } from '@idux/cdk/utils'

export type SpaceAlign = 'start' | 'center' | 'end' | 'baseline'
export type SpaceDirection = 'vertical' | 'horizontal'
export type SpaceSize = 'sm' | 'md' | 'lg'

export const spaceProps = {
align: IxPropTypes.oneOf<SpaceAlign>(['start', 'center', 'end', 'baseline']),
block: IxPropTypes.bool,
direction: IxPropTypes.oneOf<SpaceDirection>(['vertical', 'horizontal']).def('horizontal'),
gap: IxPropTypes.oneOfType([Number, String, IxPropTypes.arrayOf(Number)]),
size: IxPropTypes.oneOfType([
Number,
String,
IxPropTypes.oneOf([Number, String]),
IxPropTypes.oneOf<FormSize>(['sm', 'md', 'lg']),
]),
split: IxPropTypes.oneOfType([String, IxPropTypes.vNode]),
wrap: IxPropTypes.bool,
}
Expand Down
10 changes: 10 additions & 0 deletions packages/components/space/style/index.less
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@
&-vertical {
flex-direction: column;
}

&-block {
width: 100%;
>.@{space-prefix} {

&-item {
width: 100%;
}
}
}

&-align {

Expand Down