feat(chart): add responsive prop #31
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| import type { StoryObj } from '@storybook/vue3-vite' | ||
| import { LineChart } from '@/chart/LineChart' | ||
| import { Line } from '@/cartesian/line' | ||
| import { XAxis, YAxis } from '@/cartesian/axis' | ||
| import { CartesianGrid } from '@/cartesian/cartesian-grid' | ||
| import { Tooltip } from '@/components/Tooltip' | ||
|
|
||
| export default { | ||
| title: 'Examples/ResponsiveProp', | ||
| component: LineChart, | ||
| } | ||
|
|
||
| const data = [ | ||
| { name: 'Page A', uv: 4000 }, | ||
| { name: 'Page B', uv: 3000 }, | ||
| { name: 'Page C', uv: 2000 }, | ||
| { name: 'Page D', uv: 2780 }, | ||
| { name: 'Page E', uv: 1890 }, | ||
| { name: 'Page F', uv: 2390 }, | ||
| { name: 'Page G', uv: 3490 }, | ||
| ] | ||
|
|
||
| /** | ||
| * The `responsive` prop makes the chart fill its parent via CSS and measure itself | ||
| * with a ResizeObserver — no `ResponsiveContainer` wrapper needed. | ||
| */ | ||
| export const Responsive: StoryObj = { | ||
| render: () => { | ||
| return ( | ||
| <div style={{ width: '100%', height: '300px' }}> | ||
| <LineChart responsive data={[...data]}> | ||
| <CartesianGrid stroke-dasharray="3 3" /> | ||
| <XAxis dataKey="name" /> | ||
| <YAxis /> | ||
| <Tooltip /> | ||
| <Line type="monotone" dataKey="uv" stroke="#f97316" activeDot={{ r: 8 }} /> | ||
| </LineChart> | ||
| </div> | ||
| ) | ||
| }, | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| import { render } from '@testing-library/vue' | ||
| import { beforeEach, describe, expect, it, vi } from 'vitest' | ||
| import { nextTick } from 'vue' | ||
| import { Line, LineChart } from '@/index' | ||
| import { mockGetBoundingClientRect } from '@/test/mockGetBoundingClientRect' | ||
|
|
||
| class MockResizeObserver { | ||
| callback: ResizeObserverCallback | ||
| static instances: MockResizeObserver[] = [] | ||
|
|
||
| constructor(callback: ResizeObserverCallback) { | ||
| this.callback = callback | ||
| MockResizeObserver.instances.push(this) | ||
| } | ||
|
|
||
| observe() {} | ||
| unobserve() {} | ||
| disconnect() {} | ||
|
|
||
| trigger(width: number, height: number) { | ||
| this.callback( | ||
| [{ contentRect: { width, height } } as ResizeObserverEntry], | ||
| this as unknown as ResizeObserver, | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| const data = [ | ||
| { name: 'A', uv: 400 }, | ||
| { name: 'B', uv: 300 }, | ||
| { name: 'C', uv: 200 }, | ||
| ] | ||
|
|
||
| describe('responsive prop', () => { | ||
| beforeEach(() => { | ||
| mockGetBoundingClientRect({ width: 500, height: 300 }) | ||
| MockResizeObserver.instances = [] | ||
| vi.stubGlobal('ResizeObserver', MockResizeObserver) | ||
| }) | ||
|
|
||
| it('renders the wrapper div with 100% CSS sizing in responsive mode', async () => { | ||
| const { container } = render(() => ( | ||
| <LineChart responsive data={data}> | ||
| <Line dataKey="uv" isAnimationActive={false} /> | ||
| </LineChart> | ||
| )) | ||
| await nextTick() | ||
|
|
||
| const wrapper = container.querySelector('.v-charts-wrapper') as HTMLElement | ||
| expect(wrapper).toBeTruthy() | ||
| expect(wrapper.style.width).toBe('100%') | ||
| expect(wrapper.style.height).toBe('100%') | ||
| }) | ||
|
|
||
| it('does not render the chart surface until the wrapper is measured', () => { | ||
| // Initial measurement of 0x0 keeps the chart gated out. | ||
| mockGetBoundingClientRect({ width: 0, height: 0 }) | ||
|
|
||
| const { container } = render(() => ( | ||
| <LineChart responsive data={data}> | ||
| <Line dataKey="uv" isAnimationActive={false} /> | ||
| </LineChart> | ||
| )) | ||
|
|
||
| expect(container.querySelector('.v-charts-wrapper')).toBeTruthy() | ||
| expect(container.querySelector('.vcharts-surface')).toBeNull() | ||
| }) | ||
|
|
||
| it('renders the chart at the measured size once mounted', async () => { | ||
| const { container } = render(() => ( | ||
| <LineChart responsive data={data}> | ||
| <Line dataKey="uv" isAnimationActive={false} /> | ||
| </LineChart> | ||
| )) | ||
| await nextTick() | ||
|
|
||
| const svg = container.querySelector('.vcharts-surface') as SVGElement | ||
| expect(svg).toBeTruthy() | ||
| expect(svg.getAttribute('width')).toBe('500') | ||
| expect(svg.getAttribute('height')).toBe('300') | ||
| }) | ||
|
|
||
| it('updates the chart size when the ResizeObserver reports a new size', async () => { | ||
| const { container } = render(() => ( | ||
| <LineChart responsive data={data}> | ||
| <Line dataKey="uv" isAnimationActive={false} /> | ||
| </LineChart> | ||
| )) | ||
| await nextTick() | ||
|
|
||
| expect(MockResizeObserver.instances.length).toBe(1) | ||
| MockResizeObserver.instances[0].trigger(640, 480) | ||
| await nextTick() | ||
|
|
||
| const svg = container.querySelector('.vcharts-surface') as SVGElement | ||
| expect(svg.getAttribute('width')).toBe('640') | ||
| expect(svg.getAttribute('height')).toBe('480') | ||
| }) | ||
|
|
||
| it('renders at fixed px size and creates no ResizeObserver when responsive is not set', async () => { | ||
| const { container } = render(() => ( | ||
| <LineChart width={400} height={320} data={data}> | ||
| <Line dataKey="uv" isAnimationActive={false} /> | ||
| </LineChart> | ||
| )) | ||
| await nextTick() | ||
|
|
||
| const wrapper = container.querySelector('.v-charts-wrapper') as HTMLElement | ||
| expect(wrapper.style.width).toBe('400px') | ||
| expect(wrapper.style.height).toBe('320px') | ||
| expect(MockResizeObserver.instances.length).toBe(0) | ||
| }) | ||
| }) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🌐 Web query:
Does ResizeObserver.observe support a {box: 'border-box'} option to get border-box measurements directly?💡 Result:
Yes, the ResizeObserver.observe method supports the box option, which allows you to specify whether the observer should track changes to the element's content-box (the default) or its border-box [1][2][3]. You can use it by passing an options object as the second argument to the observe method [2][3]: resizeObserver.observe(element, { box: 'border-box' }); When this option is set, the observer monitors the size of the element's border box as defined in CSS [1][3]. This option specifically determines which box the observer monitors for layout changes [3]. Note that the ResizeObserver API also provides additional options such as 'device-pixel-content-box' for tracking sizes in device pixels [2][4][3].
Citations:
🏁 Script executed:
Repository: unovue/vue-charts
Length of output: 7935
Align the resize observer with the initial measurement.
getBoundingClientRect()returns the border box, butResizeObserverdefaults tocontentRect; ifprops.styleadds padding or a border, the firstonResizevalue will differ from later updates. UseresizeObserver.observe(wrapperEl.value, { box: 'border-box' })or make both paths measure the same box.🤖 Prompt for AI Agents