@vx/group

What is @vx/group?

@vx/group is a part of the vx (now known as visx) collection of low-level visualization components for React. It provides a way to group multiple SVG elements together, making it easier to manage and transform them as a single unit. This is particularly useful in creating complex visualizations where you need to apply transformations or styles to a collection of elements.

What are @vx/group's main functionalities?

Grouping SVG Elements

This feature allows you to group multiple SVG elements together and apply transformations such as translation. In this example, a circle and a rectangle are grouped together and translated 100 units down and 50 units to the right.

const Group = require('@vx/group').Group;

<Group top={100} left={50}>
  <circle cx={0} cy={0} r={20} fill="blue" />
  <rect x={-10} y={-10} width={20} height={20} fill="red" />
</Group>

Applying Transformations

This feature allows you to apply transformations like rotation to a group of SVG elements. In this example, a circle and a rectangle are grouped together and rotated by 45 degrees.

const Group = require('@vx/group').Group;

<Group transform="rotate(45)">
  <circle cx={50} cy={50} r={20} fill="green" />
  <rect x={40} y={40} width={20} height={20} fill="yellow" />
</Group>

Other packages similar to @vx/group

d3-selection

d3-selection is a part of the D3.js library that allows you to select and manipulate DOM elements. It provides similar functionality to @vx/group in terms of grouping and transforming elements, but it is more general-purpose and not specifically designed for React.

react-konva

react-konva is a React wrapper for the Konva.js library, which is used for creating 2D canvas graphics. It provides similar grouping and transformation functionalities but is designed for canvas elements rather than SVG.

react-spring

react-spring is a spring-physics-based animation library for React. While it is primarily used for animations, it also provides functionalities for grouping and transforming elements, making it a versatile alternative to @vx/group.

README

@vx/group

npm install --save @vx/group

A Group is a container for other objects. It lets you pass in a top and left margin and a classname.

Example usage:

import { Group } from '@vx/group';
const myGroup = (
  <Group top={50} left={20}>
    /* Children here */
  </Group>
)

Properties

Name	Default	Type	Description
top	0	number	Margin on top
left	0	number	Margin on left
className		string	The class name associated with the svg g element.

Source For Components

• <Group />

Changelog

v0.0.126

• [tooltip] add @vx/tooltip #87
• [glyph] put classname on the <path> not on <g> #87
• [mock data] add mock/bitcoinPrice #87
• [demo] add tooltip demo to dots and barstack, add legend to barstack #87
• [shape] update data passed to each bar in <BarStack /> #87