DocSpace-client/packages/shared/components/headline
2024-03-21 18:09:55 +04:00
..
Headline.constants.ts Replaced copyright start year + format 2024-03-21 18:09:55 +04:00
Headline.stories.tsx Replaced copyright start year + format 2024-03-21 18:09:55 +04:00
Headline.styled.ts Replaced copyright start year + format 2024-03-21 18:09:55 +04:00
Headline.test.tsx Replaced copyright start year + format 2024-03-21 18:09:55 +04:00
Headline.tsx Replaced copyright start year + format 2024-03-21 18:09:55 +04:00
Headline.types.ts Replaced copyright start year + format 2024-03-21 18:09:55 +04:00
README.md Shared:Components:Headline Rewrite to typescript 2024-02-08 15:46:31 +05:00

Headline

Component that displays Heading text with custom styles

Usage

import Headline from "@docspace/common/components/Headline";
<Headline type="content" title="Some title" isInline>
  Some text
</Headline>
<Headline type="header" title="Some title">
  Some text
</Headline>
<Headline type="menu" title="Some title">
  Some text
</Headline>

If you need to override styles add forwardedAs instead of as

const StyledText = styled(Headline)`
  &:hover {
    border-bottom: 1px dotted;
  }
`;
<StyledText forwardedAs="span" title="Some title">
  Some text
</StyledText>

Properties

Props Type Required Values Default Description
color string - - #333333 Specifies the contentHeader color
isInline bool - - false Sets the 'display: inline-block' property
title bool - - - Title
truncate bool - - false Disables word wrapping
type oneOf content, header, menu - Sets the size of text: content (21px), header (28px) or menu (27px)