@viamrobotics/prime-core

Getting started

@viamrobotics/prime-core is a collection of core Svelte components.

Installation

Add PRIME core using your package manager of choice:

``
pnpm add --save-dev @viamrobotics/prime-core
`

Install [Tailwind][]. In the tailwind.config.js, add the components to the content and include the theme:

`js
import { theme } from '@viamrobotics/prime-core/theme';
import { plugins } from '@viamrobotics/prime-core/plugins';

/* @type {import('tailwindcss').Config} /
export default {
content: [
'./src/*/.{html,js,svelte,ts}',
'./node_modules/@viamrobotics/prime-core/*/.{ts,svelte}',
],
theme,
plugins,
};
`

Import the stylesheet. If you are using [SvelteKit][], you can do this in src/routes/+layout.svelte.

`js
import '@viamrobotics/prime-core/prime.css';
`

Usage

Once installed, you can use the components in your app:

`html


variant="green"
label="Active"
/>
`

[tailwind]: https://tailwindcss.com/
[sveltekit]: https://kit.svelte.dev/

$3

All Prime components have their own test suites, so in your application tests, you generally only need to test that the component itself is rendered rather than try to test that all the behaviors work - we've already written those tests.

#### Testing toasts

The useToast hook requires a Svelte context to render. In order to test a component that issues toasts, you can use the createNoopToastContext fixture. Before using this fixture, consider if you can re-structure your components to avoid the need for testing a component wired to useToast directly.

`ts
import { describe, expect, test, vi } from 'vitest';
import { render } from '@testing-library/svelte';

import { createNoopToastContext } from '@viamrobotics/prime-core/__fixtures__';

import Subject from '../cool-component.svelte';

const toast = vi.fn();

const renderSubject = () => {
const toastContext = createNoopToastContext(toast);
return render(Subject, {
props: { message: 'hello' },
context: new Map([toastContext]),
});
};

describe('', () => {
it('toasts message on mount', () => {
renderSubject();
expect(toast).toHaveBeenCalledWith({ message: 'hello' });
});
});
`

Playground

The playground can be used during development but is not used outside of the package.

`bash
pnpm install
pnpm -C packages/core dev
`

Linting

To lint and typecheck:

`bash
pnpm -C packages/core check # check svelte and lint
pnpm -C packages/core check-svelte # check svelte only
pnpm -C packages/core check-lint # check lint only with prettier and eslint
pnpm -C packages/core format # format with prettier
`

Testing

To test with [vitest][]:

`bash
pnpm -C packages/core test # run once
pnpm -C packages/core test:watch # watch tests
`

[vitest]: https://vitest.dev/

Anatomy of a Component

For easier readability, we try to use a standard ordering for component composition. These are not strict rules, but more a guideline to follow. Implementation specifics may force you to go outside this guideline.

`html



lang="ts"
context="module"
>
// exported types
export type MyType = 'thing' | 'other-thing';



`

Tests and Test Components

We keep tests in a __tests__ directory that is a sibling of the code being tested. These directories should only contain tests and test components.

Some components require test components to render slotted children, due to limitations with rendering slots using @testing-library`.

See:

- https://sveltesociety.dev/recipes/testing-and-debugging/unit-testing-svelte-component
- https://github.com/testing-library/svelte-testing-library/issues/48