@gravity-ui/page-constructor 1.0.0

package/server/models/constructor-items/blocks.d.ts

@@ -0,0 +1,339 @@
+/// <reference types="react" />
+import { BackgroundImageProps, ButtonProps, ContentSize, ContentTextSize, ContentTheme, FileLinkProps, HeaderBreadCrumbsProps, HeaderImageSize, HeaderOffset, HeaderWidth, Justify, LinkProps, LinkTheme, MediaDirection, MediaProps, PreviewItemProps, PreviewRatioMediaContent, TextSize, TextTheme, ThemedImage, ThemedMediaProps, ThemedMediaVideoProps, TitleProps, LegendTableMarkerType, AnchorProps, TitleBaseProps, Animatable, BlockHeaderProps } from './common';
+import { ThemeSupporting } from '../../utils';
+import { GridColumnSize, GridColumnSizesType } from '../../grid/types';
+import { BannerCardProps, SubBlock } from './sub-blocks';
+export declare enum BlockType {
+    PromoFeaturesBlock = "promo-features-block",
+    ExtendedFeaturesBlock = "extended-features-block",
+    SliderBlock = "slider-block",
+    CalculatorBlock = "calculator-block",
+    ServiceDemoBlock = "service-demo-block",
+    QuestionsBlock = "questions-block",
+    BannerBlock = "banner-block",
+    CompaniesBlock = "companies-block",
+    MediaBlock = "media-block",
+    PreviewBlock = "preview-block",
+    InfoBlock = "info-block",
+    SecurityBlock = "security-block",
+    TableBlock = "table-block",
+    TabsBlock = "tabs-block",
+    SimpleBlock = "simple-block",
+    HeaderSliderBlock = "header-slider-block",
+    LinkTableBlock = "link-table-block",
+    HeaderBlock = "header-block",
+    IconsBlock = "icons-block",
+    CardLayoutBlock = "card-layout-block",
+    ContentLayoutBlock = "content-layout-block"
+}
+export declare const BlockTypes: BlockType[];
+export declare const HeaderBlockTypes: BlockType[];
+export interface Childable {
+    children?: SubBlock[];
+}
+export interface BlockBaseProps {
+    anchor?: AnchorProps;
+    visible?: GridColumnSize;
+    resetPaddings?: boolean;
+}
+export interface LoadableProps {
+    source: string;
+    /**
+     * @deprecated Will be moved to params
+     */
+    serviceId?: number;
+    params?: Record<string, string | number | boolean>;
+}
+export interface LoadableChildren {
+    loadable?: LoadableProps;
+}
+export declare type ServiceDemoProps = Animatable;
+export declare enum SliderBreakpointNames {
+    Sm = "sm",
+    Md = "md",
+    Lg = "lg",
+    Xl = "xl"
+}
+export declare enum SliderType {
+    MediaCard = "media-card",
+    HeaderCard = "header-card"
+}
+export declare type SliderBreakpointParams = Record<SliderBreakpointNames, number>;
+export declare type SlidesToShow = Partial<SliderBreakpointParams> | number;
+export interface SliderProps extends Childable, Animatable, LoadableChildren {
+    dots?: boolean;
+    arrows?: boolean;
+    slidesToShow?: SlidesToShow;
+    disclaimer?: {
+        text: string;
+        size?: TextSize;
+    };
+    title?: TitleBaseProps;
+    description?: string;
+    autoplay?: number;
+    randomOrder?: boolean;
+    adaptive?: boolean;
+}
+export interface HeaderSliderBlockProps extends Omit<SliderProps, 'title' | 'description'> {
+    items: HeaderBlockProps[];
+}
+interface HeaderBackgroundProps {
+    color?: string;
+    url?: string;
+    disableCompress?: boolean;
+}
+export interface HeaderBlockBackground extends Partial<HeaderBackgroundProps>, Partial<MediaProps> {
+    fullWidth?: boolean;
+    fullWidthMedia?: boolean;
+}
+export declare type ThemedHeaderBlockBackground = ThemeSupporting<HeaderBlockBackground>;
+export interface HeaderBlockProps {
+    title: string;
+    overtitle?: string;
+    description?: string;
+    buttons?: Pick<ButtonProps, 'url' | 'text' | 'theme' | 'primary' | 'size'>[];
+    width?: HeaderWidth;
+    /** @deprecated imageSize now depends on width */
+    imageSize?: HeaderImageSize;
+    /**
+     * @deprecated used only on the main page
+     * TODO: delete after the possibility to remove padding-bottom in the block
+     */
+    offset?: HeaderOffset;
+    image?: ThemedImage;
+    video?: ThemedMediaVideoProps;
+    background?: ThemedHeaderBlockBackground;
+    theme?: 'light' | 'dark';
+    verticalOffset?: 's' | 'm' | 'l' | 'xl';
+    breadcrumbs?: HeaderBreadCrumbsProps;
+    status?: JSX.Element;
+}
+export declare type CalculatorProps = Animatable;
+export interface SimpleBlockProps extends Animatable, Childable {
+    title: TitleBaseProps;
+    description: string;
+}
+export interface ExtendedFeaturesItem {
+    title?: string;
+    text?: string;
+    label?: string;
+    icon?: string;
+    link?: LinkProps;
+}
+export interface ExtendedFeaturesProps extends Animatable {
+    items: ExtendedFeaturesItem[];
+    title?: TitleProps | string;
+    description?: string;
+    colSizes?: GridColumnSizesType;
+}
+export interface PromoFeaturesItem {
+    title: string;
+    text: string;
+    theme?: 'accent' | 'accent-light' | 'primary';
+    media?: MediaProps;
+}
+export interface PromoFeaturesProps extends Animatable {
+    items: PromoFeaturesItem[];
+    title?: TitleProps | string;
+    description?: string;
+    theme?: 'grey' | 'default';
+}
+export interface QuestionItem {
+    title: string;
+    text: string;
+    listStyle?: 'dash' | 'disk';
+    link?: LinkProps;
+}
+export interface QuestionsProps extends Omit<ContentBlockProps, 'colSizes' | 'centered' | 'size' | 'theme'> {
+    items: QuestionItem[];
+}
+export interface BannerBlockProps extends BannerCardProps, Animatable {
+}
+export interface CompaniesBlockProps extends Animatable {
+    title: string;
+    images: ThemeSupporting<{
+        desktop: string;
+        tablet: string;
+        mobile: string;
+        alt?: string;
+    }>;
+}
+export interface MediaContentProps {
+    title: string;
+    description?: string;
+    additionalInfo?: string;
+    button?: ButtonProps;
+    links?: LinkProps[];
+    buttons?: ButtonProps[];
+    size?: ContentSize;
+}
+export interface MediaBlockProps extends Animatable, MediaContentProps {
+    media: ThemeSupporting<MediaProps>;
+    direction?: MediaDirection;
+    mobileDirection?: MediaDirection;
+    largeMedia?: boolean;
+    mediaOnly?: boolean;
+    disableShadow?: boolean;
+}
+export interface PreviewBlockProps extends Animatable {
+    title: string;
+    items: PreviewItemProps[];
+    description?: string;
+    direction?: MediaDirection;
+    ratioMediaContent?: PreviewRatioMediaContent;
+    stopVideo?: boolean;
+    showImmediately?: boolean;
+}
+export interface InfoBlockProps {
+    theme?: TextTheme;
+    backgroundColor?: ThemeSupporting<string>;
+    title: string;
+    buttons?: Pick<ButtonProps, 'url' | 'text' | 'theme'>[];
+    sectionsTitle: string;
+    links?: Pick<LinkProps, 'text' | 'url'>[];
+}
+export interface SecurityBlockPoint {
+    img: string;
+    text: string;
+    link: {
+        text: string;
+        url: string;
+    };
+}
+export interface SecurityBlockProps extends Animatable {
+    theme?: TextTheme;
+    backgroundColor?: string;
+    title: string;
+    points?: SecurityBlockPoint[];
+    media: MediaProps;
+}
+export interface TableProps {
+    content: string[][];
+    legend?: string[];
+    justify?: Justify[];
+    marker?: LegendTableMarkerType;
+}
+export interface TableBlockProps {
+    title: string;
+    table: TableProps;
+}
+export interface TabsBlockItem {
+    tabName: string;
+    title: string;
+    text: string;
+    link?: LinkProps;
+    image?: ThemedImage;
+    disableCompress?: boolean;
+    caption?: string;
+    media?: ThemedMediaProps;
+    links?: LinkProps[];
+}
+export interface TabsBlockProps extends BlockHeaderProps, Animatable {
+    items: TabsBlockItem[];
+}
+export interface LinkTableBlockProps extends BlockHeaderProps {
+    items: LinkProps[][];
+    linkTheme?: LinkTheme;
+}
+export interface CardLayoutBlockProps extends Childable, Animatable, LoadableChildren {
+    title: TitleProps | string;
+    description?: string;
+    colSizes?: GridColumnSizesType;
+}
+export interface IconsBlockProps {
+    title?: string;
+    size: 's' | 'm' | 'l';
+    items: {
+        url: string;
+        text: string;
+        src: string;
+    }[];
+}
+export interface ContentLayoutBlockProps {
+    properties?: {
+        size?: ContentSize;
+        background?: BackgroundImageProps;
+        centered?: boolean;
+        theme?: ContentTheme;
+        textWidth?: ContentTextSize;
+    };
+    textContent: ContentBlockProps;
+    fileContent?: FileLinkProps[];
+}
+export interface ContentBlockProps {
+    title?: TitleBaseProps | string;
+    text?: string;
+    additionalInfo?: string;
+    links?: LinkProps[];
+    buttons?: ButtonProps[];
+    size?: ContentSize;
+    colSizes?: GridColumnSizesType;
+    centered?: boolean;
+    theme?: ContentTheme;
+}
+export declare type HeaderBlockModel = {
+    type: BlockType.HeaderBlock;
+} & HeaderBlockProps;
+export declare type CalculatorBlockModel = {
+    type: BlockType.CalculatorBlock;
+} & CalculatorProps;
+export declare type SliderBlockModel = {
+    type: BlockType.SliderBlock;
+} & SliderProps;
+export declare type ServiceDemoBlockModel = {
+    type: BlockType.ServiceDemoBlock;
+} & ServiceDemoProps;
+export declare type ExtendedFeaturesBlockModel = {
+    type: BlockType.ExtendedFeaturesBlock;
+} & ExtendedFeaturesProps;
+export declare type PromoFeaturesBlockModel = {
+    type: BlockType.PromoFeaturesBlock;
+} & PromoFeaturesProps;
+export declare type QuestionsBlockModel = {
+    type: BlockType.QuestionsBlock;
+} & QuestionsProps;
+export declare type BannerBlockModel = {
+    type: BlockType.BannerBlock;
+} & BannerBlockProps;
+export declare type CompaniesBlockModel = {
+    type: BlockType.CompaniesBlock;
+} & CompaniesBlockProps;
+export declare type MediaBlockModel = {
+    type: BlockType.MediaBlock;
+} & MediaBlockProps;
+export declare type PreviewBlockModel = {
+    type: BlockType.PreviewBlock;
+} & PreviewBlockProps;
+export declare type InfoBlockModel = {
+    type: BlockType.InfoBlock;
+} & InfoBlockProps;
+export declare type SecurityBlockModel = {
+    type: BlockType.SecurityBlock;
+} & SecurityBlockProps;
+export declare type TableBlockModel = {
+    type: BlockType.TableBlock;
+} & TableBlockProps;
+export declare type TabsBlockModel = {
+    type: BlockType.TabsBlock;
+} & TabsBlockProps;
+export declare type SimpleBlockModel = {
+    type: BlockType.SimpleBlock;
+} & SimpleBlockProps;
+export declare type LinkTableBlockModel = {
+    type: BlockType.LinkTableBlock;
+} & LinkTableBlockProps;
+export declare type CardLayoutBlockModel = {
+    type: BlockType.CardLayoutBlock;
+} & CardLayoutBlockProps;
+export declare type IconsBlockModel = {
+    type: BlockType.IconsBlock;
+} & IconsBlockProps;
+export declare type HeaderSliderBlockModel = {
+    type: BlockType.HeaderSliderBlock;
+} & HeaderSliderBlockProps;
+export declare type ContentLayoutBlockModel = {
+    type: BlockType.ContentLayoutBlock;
+} & ContentLayoutBlockProps;
+declare type BlockModels = SliderBlockModel | ServiceDemoBlockModel | ExtendedFeaturesBlockModel | PromoFeaturesBlockModel | QuestionsBlockModel | CalculatorBlockModel | BannerBlockModel | CompaniesBlockModel | MediaBlockModel | InfoBlockModel | SecurityBlockModel | TableBlockModel | TabsBlockModel | SimpleBlockModel | LinkTableBlockModel | HeaderBlockModel | PreviewBlockModel | IconsBlockModel | HeaderSliderBlockModel | CardLayoutBlockModel | ContentLayoutBlockModel;
+export declare type Block = BlockModels & BlockBaseProps;
+export {};

package/server/models/constructor-items/blocks.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SliderType = exports.SliderBreakpointNames = exports.HeaderBlockTypes = exports.BlockTypes = exports.BlockType = void 0;
+var BlockType;
+(function (BlockType) {
+    BlockType["PromoFeaturesBlock"] = "promo-features-block";
+    BlockType["ExtendedFeaturesBlock"] = "extended-features-block";
+    BlockType["SliderBlock"] = "slider-block";
+    BlockType["CalculatorBlock"] = "calculator-block";
+    BlockType["ServiceDemoBlock"] = "service-demo-block";
+    BlockType["QuestionsBlock"] = "questions-block";
+    BlockType["BannerBlock"] = "banner-block";
+    BlockType["CompaniesBlock"] = "companies-block";
+    BlockType["MediaBlock"] = "media-block";
+    BlockType["PreviewBlock"] = "preview-block";
+    BlockType["InfoBlock"] = "info-block";
+    BlockType["SecurityBlock"] = "security-block";
+    BlockType["TableBlock"] = "table-block";
+    BlockType["TabsBlock"] = "tabs-block";
+    BlockType["SimpleBlock"] = "simple-block";
+    BlockType["HeaderSliderBlock"] = "header-slider-block";
+    BlockType["LinkTableBlock"] = "link-table-block";
+    BlockType["HeaderBlock"] = "header-block";
+    BlockType["IconsBlock"] = "icons-block";
+    BlockType["CardLayoutBlock"] = "card-layout-block";
+    BlockType["ContentLayoutBlock"] = "content-layout-block";
+})(BlockType = exports.BlockType || (exports.BlockType = {}));
+exports.BlockTypes = Object.values(BlockType);
+exports.HeaderBlockTypes = [BlockType.HeaderBlock, BlockType.HeaderSliderBlock];
+var SliderBreakpointNames;
+(function (SliderBreakpointNames) {
+    SliderBreakpointNames["Sm"] = "sm";
+    SliderBreakpointNames["Md"] = "md";
+    SliderBreakpointNames["Lg"] = "lg";
+    SliderBreakpointNames["Xl"] = "xl";
+})(SliderBreakpointNames = exports.SliderBreakpointNames || (exports.SliderBreakpointNames = {}));
+var SliderType;
+(function (SliderType) {
+    SliderType["MediaCard"] = "media-card";
+    SliderType["HeaderCard"] = "header-card";
+})(SliderType = exports.SliderType || (exports.SliderType = {}));