All files / libs/payout-definition/plans/views/hub/rule-designer/src/lib/drawer PlanHubRuleDesignerFunctionDocumentationOverlay.tsx

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import styled from '@emotion/styled';
import { IconX } from '@tabler/icons-react';
import { memo } from 'react';
import { FormattedMessage } from 'react-intl';

import { Divider, Group, IconButton, Typography } from '@allshares/studio-design-system';
import { type AmaliaFunction } from '@amalia/amalia-lang/formula/evaluate/shared';

const COLON_WITH_SPACE = ': ';

const StyledFunctionDocumentationContainer = styled.div<{
  readonly drawerWith: number;
  readonly isAnimationActive: boolean;
}>`
  background-color: ${({ theme }) => theme.ds.colors.gray[0]};
  border-right: 1px solid ${({ theme }) => theme.ds.colors.gray[100]};
  height: 100%;
  left: ${({ drawerWith }) => `${drawerWith}px`};
  overflow-y: auto;
  overflow-x: hidden;
  word-wrap: break-word;
  position: absolute;
  transition: ${({ isAnimationActive }) => isAnimationActive && 'left 0.2s'};
  width: 350px;
  z-index: 50;

  [data-color-scheme='dark'] & {
    background-color: ${({ theme }) => theme.ds.colors.dark[800]};
    border-color: ${({ theme }) => theme.ds.colors.dark[600]};
  }
`;

const StyledFunctionDocumentationHeader = styled.div`
  padding: 24px;
`;

const StyledFunctionDocumentationDescription = styled.div`
  padding-top: 16px;
`;

const StyledFunctionDocumentationParameters = styled.div`
  padding: 16px 24px 24px 24px;
`;

const StyledFunctionDocumentationParameter = styled.div<{
  isFirstParameter: boolean;
}>`
  padding-top: ${({ isFirstParameter }) => (isFirstParameter ? '16px' : '8px')};
`;

const StyledFunctionDocumentationExamples = styled.div`
  padding: 16px 24px;
`;

const StyledFunctionDocumentationExample = styled.div`
  padding-top: 16px;
`;

const StyledFunctionDocumentationExampleDescription = styled.div`
  padding-top: 8px;
`;

interface PlanHubRuleDesignerFunctionDocumentationOverlayProps {
  readonly drawerWidth: number;
  readonly functionDocumentation: AmaliaFunction;
  readonly isAnimationActive?: boolean;
  readonly onCloseOverlay: () => void;
}

export const PlanHubRuleDesignerFunctionDocumentationOverlay = memo(
  function PlanHubRuleDesignerFunctionDocumentationOverlay({
    drawerWidth,
    functionDocumentation,
    isAnimationActive = false,
    onCloseOverlay,
  }: PlanHubRuleDesignerFunctionDocumentationOverlayProps) {
    return (
      <StyledFunctionDocumentationContainer
        drawerWith={drawerWidth}
        isAnimationActive={isAnimationActive}
      >
        <StyledFunctionDocumentationHeader>
          <Group
            align="center"
            justify="space-between"
          >
            <Typography variant="bodyBaseMedium">
              <FormattedMessage
                defaultMessage="{functionName} function"
                values={{ functionName: functionDocumentation.name }}
              />
            </Typography>

            <IconButton
              icon={<IconX />}
              label={<FormattedMessage defaultMessage="Close" />}
              size="small"
              onClick={onCloseOverlay}
            />
          </Group>

          <StyledFunctionDocumentationDescription>
            <Typography variant="bodySmallRegular">{functionDocumentation.description}</Typography>
          </StyledFunctionDocumentationDescription>
        </StyledFunctionDocumentationHeader>

        <Divider.Horizontal
          darkGrayShade={600}
          grayShade={100}
        />

        <StyledFunctionDocumentationParameters>
          <Typography variant="bodyBaseMedium">
            <FormattedMessage defaultMessage="Parameters" />
          </Typography>

          {functionDocumentation.params.map((param, paramIndex) => (
            <StyledFunctionDocumentationParameter
              key={param.name}
              isFirstParameter={paramIndex === 0}
            >
              <Typography variant="bodySmallMedium">{param.name}</Typography>
              <Typography variant="bodySmallRegular">
                {COLON_WITH_SPACE}
                {param.description}
              </Typography>
            </StyledFunctionDocumentationParameter>
          ))}
        </StyledFunctionDocumentationParameters>

        <Divider.Horizontal
          darkGrayShade={600}
          grayShade={100}
        />

        <StyledFunctionDocumentationExamples>
          <Typography variant="bodyBaseMedium">
            <FormattedMessage defaultMessage="Examples" />
          </Typography>

          {functionDocumentation.examples.map((example) => (
            <StyledFunctionDocumentationExample key={example.formula}>
              <div>
                <Typography variant="monospaceSmall">{example.formula}</Typography>
              </div>

              <StyledFunctionDocumentationExampleDescription>
                <Typography variant="bodySmallRegular">{example.desc}</Typography>
              </StyledFunctionDocumentationExampleDescription>
            </StyledFunctionDocumentationExample>
          ))}
        </StyledFunctionDocumentationExamples>
      </StyledFunctionDocumentationContainer>
    );
  },
);