Suit
Display bridge suit symbols with variant-specific icons and colors.
Import from @workspace/ui-bridge/suit/suit-display.
SuitDisplay
A suit as its icon (default), its translated name, or both, in the card or bid palette. In petit bridge the name is the color of the suit (blue, red, yellow, green), from suit.petitBridgeSuits of the Strings Provider. Uses useBridgeEngine() internally for the glyph family and colors of the active rules variant (classic or petit-bridge).
import { SuitDisplay } from '@workspace/ui-bridge/suit/suit-display';
<SuitDisplay suit="S" />
<SuitDisplay suit="H" colorVariant="bid" />
<SuitDisplay suit="D" variant="icon+label" />Gallery
Every suit in each glyph family and palette. The bid palette only exists in modes with auctions; petit bridge renders every suit as the same square, told apart by color alone.
light
Classic · card
Classic · bid
Classic · label and icon+label
Petit bridge
Petit bridge · icon+label (colors)
dark
Classic · card
Classic · bid
Classic · label and icon+label
Petit bridge
Petit bridge · icon+label (colors)
Props
Prop
Type
Suit Icons
The module re-exports individual suit icon components for direct use:
import {
SpadeSuit,
HeartSuit,
DiamondSuit,
ClubSuit,
PetitBridgeSuit,
} from '@workspace/ui-bridge/suit/suit-icons';| Component | Description |
|---|---|
SpadeSuit | Spade icon (classic variant) |
HeartSuit | Heart icon (classic variant) |
DiamondSuit | Diamond icon (classic variant) |
ClubSuit | Club icon (classic variant) |
PetitBridgeSuit | Special suit icon (petit-bridge variant) |
Constants
| Export | Description |
|---|---|
DEFAULT_SUIT_ICONS | Default icon components per suit |
DEFAULT_SUIT_COLORS | Default color classes per suit |