Skip to content

The open alternative to Salesforce, designed for AI.

2.1 KB
Raw Blame
import { readFileSync } from 'node:fs';
import { describe, expect, it } from 'vitest';

import { normalizeDocumentationDefaultValue } from '../../../../twenty-ui/docs/normalizeDocumentationDefaultValue';
import { renderComponentReference } from '../render-component-reference';

describe('documentation defaults', () => {
  it('documents render-dependent native button defaults on dropdown parts', () => {
    const reference = readFileSync(
      new URL(
        '../../../snippets/ui/generated/components/navigation/dropdown.mdx',
        import.meta.url,
      ),
      'utf8',
    );

    for (const part of ['ActionItem', 'OptionItem', 'Back', 'SubmenuTrigger']) {
      expect(reference).toContain(
        `body="${part}.nativeButton" type="boolean" default="true when render is omitted; false otherwise"`,
      );
    }
  });

  it.each([
    ["'onSubmit'", 'onSubmit'],
    ['"horizontal"', 'horizontal'],
    ["'it\\'s ready'", "it's ready"],
    ['"undefined"', 'undefined'],
    ["''", ''],
    ['accent', 'accent'],
    [false, 'false'],
    [0, '0'],
    [null, 'null'],
    [undefined, null],
    ['undefined', null],
  ])('normalizes %j to %j', (value, expected) => {
    expect(normalizeDocumentationDefaultValue({ value })).toBe(expected);
  });

  it('omits absent defaults and renders string defaults without display quotes', () => {
    const reference = renderComponentReference({
      name: 'Example',
      entryPoint: 'twenty-ui/primitives/input',
      slug: 'input/example',
      props: [
        {
          name: 'mode',
          type: 'string',
          required: false,
          defaultValue: normalizeDocumentationDefaultValue({
            value: "'onSubmit'",
          }),
          description: '',
        },
        {
          name: 'checked',
          type: 'boolean',
          required: false,
          defaultValue: normalizeDocumentationDefaultValue({
            value: 'undefined',
          }),
          description: '',
        },
      ],
    });

    expect(normalizeDocumentationDefaultValue(null)).toBeNull();
    expect(reference).toContain('default="onSubmit"');
    expect(reference.match(/default=/g)).toHaveLength(1);
  });
});