interact/packages/interact-validate/test/rules/recommendedFillBackwards.spec.ts at ae755077e79643b8c9c2a41d180a8d2cd1c53bc6 · wix/interact · GitHub

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
158
159
160
161
162
163
164
165
import { describe, expect, it } from 'vitest';
import { validateInteractConfig } from '../../src';

const CODE = 'RECOMMENDED_FILL_BACKWARDS';

describe('recommendedFillBackwards — RECOMMENDED_FILL_BACKWARDS', () => {
  it('warns for a viewEnter once effect that omits fill', () => {
    const result = validateInteractConfig({
      interactions: [
        {
          key: 'el',
          trigger: 'viewEnter',
          effects: [{ namedEffect: { type: 'FadeIn' }, duration: 400, triggerType: 'once' }],
        },
      ],
    });

    const err = result.errors.find((e) => e.code === CODE);
    expect(err).toBeDefined();
    expect(err?.severity).toBe('info');
    expect(err?.path).toEqual(['interactions', 0, 'effects', 0, 'fill']);
    expect(result.valid).toBe(true);
  });

  it('warns for a viewEnter effect with implicit once triggerType', () => {
    const result = validateInteractConfig({
      interactions: [
        {
          key: 'el',
          trigger: 'viewEnter',
          effects: [{ namedEffect: { type: 'FadeIn' }, duration: 400 }],
        },
      ],
    });

    expect(result.errors.some((e) => e.code === CODE)).toBe(true);
  });

  it('warns for a viewEnter once keyframeEffect without fill', () => {
    const result = validateInteractConfig({
      interactions: [
        {
          key: 'el',
          trigger: 'viewEnter',
          effects: [
            {
              keyframeEffect: { name: 'fade', keyframes: [{ opacity: '0' }, { opacity: '1' }] },
              duration: 400,
              delay: 200,
            },
          ],
        },
      ],
    });

    expect(result.errors.some((e) => e.code === CODE)).toBe(true);
  });

  it('warns for a viewEnter once sequence effect without fill', () => {
    const result = validateInteractConfig({
      interactions: [
        {
          key: 'el',
          trigger: 'viewEnter',
          sequences: [
            {
              effects: [
                {
                  selector: '.card',
                  namedEffect: { type: 'FadeIn' },
                  duration: 400,
                },
              ],
            },
          ],
        },
      ],
    });

    expect(
      result.errors.some(
        (e) => e.code === CODE && e.path.join('.') === 'interactions.0.sequences.0.effects.0.fill',
      ),
    ).toBe(true);
  });

  describe('no warning for the documented valid patterns', () => {
    it('does not warn when fill: backwards is present', () => {
      const result = validateInteractConfig({
        interactions: [
          {
            key: 'el',
            trigger: 'viewEnter',
            effects: [
              {
                fill: 'backwards',
                namedEffect: { type: 'FadeIn' },
                duration: 400,
                triggerType: 'once',
              },
            ],
          },
        ],
      });

      expect(result.errors.filter((e) => e.code === CODE)).toHaveLength(0);
    });

    it('does not warn when fill: both is present', () => {
      const result = validateInteractConfig({
        interactions: [
          {
            key: 'el',
            trigger: 'viewEnter',
            effects: [
              {
                fill: 'both',
                namedEffect: { type: 'FadeIn' },
                duration: 400,
                triggerType: 'once',
              },
            ],
          },
        ],
      });

      expect(result.errors.filter((e) => e.code === CODE)).toHaveLength(0);
    });

    it('does not warn for non-viewEnter triggers', () => {
      const result = validateInteractConfig({
        interactions: [
          {
            key: 'el',
            trigger: 'click',
            effects: [{ namedEffect: { type: 'FadeIn' }, duration: 400 }],
          },
        ],
      });

      expect(result.errors.filter((e) => e.code === CODE)).toHaveLength(0);
    });

    it('does not warn for viewEnter repeat effects', () => {
      const result = validateInteractConfig({
        interactions: [
          {
            key: 'el',
            trigger: 'viewEnter',
            effects: [
              {
                key: 'other',
                namedEffect: { type: 'FadeIn' },
                duration: 400,
                triggerType: 'repeat',
              },
            ],
          },
        ],
      });

      expect(result.errors.filter((e) => e.code === CODE)).toHaveLength(0);
    });
  });
});