tide-design-system 2.5.13 → 2.5.15

package/docs/configuation.md

@@ -1,47 +0,0 @@
-# TIDE Configuration
-
-You can configure global TIDE behavior using `provideTideConfig()`. Place it in a top-level file such as `app.vue` (anywhere Vue’s `provide()` works). See Vue’s docs on [provide/inject](https://vuejs.org/guide/components/provide-inject) for more details.
-
-## `provideTideConfig()`
-
-``` ts
-import { provideTideConfig } from 'tide-design-system';
-
-provideTideConfig({
-  linkComponent: 'a', // default
-});
-```
-
-### Config values
-
-| Key | Type | Default | Description |
-| --- | --- | --- | --- |
-| `linkComponent` | `'a' \| Component` | `'a'` | Replaces the root element used by link-based TIDE components. |
-
-## `linkComponent` (TIDE 2.5+)
-
-Use this to replace all `<a>` elements in TIDE components with a custom component. Useful for frameworks like Nuxt.
-
-### Nuxt Example (using `NuxtLink`)
-
-``` vue
-<!-- app.vue -->
-<script setup lang="ts">
-  import { provideTideConfig } from 'tide-design-system';
-  import { NuxtLink } from '#components';
-
-  provideTideConfig({
-    linkComponent: NuxtLink,
-  });
-</script>
-```
-
-This updates all TIDE components that render links, including:
-
-- TideLink
-- TideButton (`:element="ELEMENT.LINK"`)
-- TideCard (`:type="TYPE_CARD.ACTION"` with `href`)
-- TideBreadCrumbs
-- And others
-
-All these will now render using `<NuxtLink />` automatically.

package/docs/development.md

@@ -1,163 +0,0 @@
-# TIDE Development
-
-## Setup
-
-1. Clone repository:
-
-    `git clone git@github.com:traderinteractive/tide-design-system.git`
-
-2. Install packages:
-
-    `cd tide-design-system`
-
-    `npm install`
-
-3. Generate distribution files:
-
-    `npm build`
-
-## Scripts
--  `npm run build`: Generate package.
--  `npm run build-storybook`: Generate Storybook UI.
--  `npm run coverage`: Display unit test statistics.
--  `npm run lint`: Detect ESLint issues.
--  `npm run lint:fix`: Autofix ESLint issues where available.
--  `npm run precommit`: Run all linting, type-checking, and testing commands.
--  `npm run preview`: Serve Storybook UI in production mode.
--  `npm run storybook`: Serve Storybook UI in development mode.
--  `npm run test`: Run unit test suite.
--  `npm run type-check`: Detect TypeScript errors.
-
-## Workflow
-
-1. Develop the indicated TIDE structures in the TIDE repository as normal.
-    - `src/components/TideSample.vue`
-    - `src/types/Sample.ts`
-    - `src/utilities/sample.ts`
-2. Thoroughly test the solution:
-   1. Via Storybook (Required):
-      1. Develop the relevant Storybook story:
-
-           - `src/stories/TideSample.stories.ts`
-      2. Serve the Storybook interface locally:
-
-            `npm run storybook`
-
-      3. Thoroughly test all arg selections both in isolation and in combination and verify that both the Canvas and the Code Snippet accurately reflect the correct implementation.
-   2. Via Sandbox App
-
-        Apart from locally serving the TIDE Storybook interface, you can also develop a local, temporary proof-of-concept that instantiates the structure under development, then serve the project locally to verify.
-
-      1. Open the top-level Sandbox App component:
-
-            `src/contexts/sandbox/AppSandbox.vue`
-      2. Explicitly import the local structures (unlike importing from external dependency):
-
-            `import TideSample from '@/components/TideSample.vue';`
-      3. Instantiate the structures:
-
-            `<TideSample />`
-      4. Serve the Sandbox App locally:
-
-            `npm run dev`
-
-   3. Via NPM Link
-
-        Note: If using Windows Subsystem for Linux (WSL), both the TIDE repository and the consumer repository need to be pulled down into the Linux environment.
-
-      1. From the local instance of TIDE repository, create local package alias:
-
-            `npm link`
-      2. From the local instance of the consumer repository, leverage local package alias:
-
-            `npm link tide-design-system`
-
-      3. Run the local instance of `tide-design-system`.
-      4. Run the local instance of the consumer repository.
-      5. Visit the local instance of the consumer repository in the browser as normal. All structures imported from the `tide-design-system` dependency will now reflect the local instance.
-   4. Via Unit Tests (Strongly encouraged).
-      1. Develop relevant unit tests:
-        - `tests/tide-sample.spec.ts`
-        - `tests/utilities-sample.spec.ts`
-      2. Run all unit tests:
-
-            `npm run test`
-
-         1. Verify that all tests passed.
-         2. Verify that no tests were skipped.
-         3. Verify that there were no errors.
-      3. Check test coverage:
-
-            `npm run coverage`
-3. Open a GitHub pull request from the ticket branch to the `main` branch of the TIDE repository.
-   1. All TIDE repository pull requests require one approval from a TIDE repository admin.
-   2. Once approved, a TIDE repository admin will merge the pull request, assign it a milestone, and update the status of the relevant Jira ticket to `Merged`, then reassign it to themselves pending publication.
-
-## Publication (TIDE Tech Lead only)
-1. Test via local integration (see above).
-2. Determine new version via custom semantic versioning rules:
-
-   1. `#` Redesign/rebranding release (RESTRICTED)
-   2. `#.#` Non-backward compatible bugfix or feature
-   3. `#.#.#` Backward compatible bugfix or feature
-
-   - Numerical pattern will be used for configuration: `#.#.#`
-   - Alphanumeric pattern will be used for naming: `v#.#.#`
-3. Check out the current commit from the trunk:
-
-    `git checkout upstream/main`
-
-4. Create a new local branch based on the alphanumeric version:
-
-    `git checkout -b v#.#.#`
-
-5. Manually update the `version` property in `package.json` to reflect the numeric version.
-6. Update `package-lock.json` in parallel:
-
-   `npm install`
-
-7. Verify that only the 2 files mentioned above have been modified:
-
-    `git status`
-
-8. Verify that the diffset is correct:
-
-   `git diff`
-
-9. Verify that all linting, type-checks, and unit tests pass:
-
-    `npm run precommit`
-
-10. Stage all local changes for commit:
-
-   `git add .`
-
-11. Commit the staged changes with a message matching the standard release message format:
-
-    `npm commit -m 'Release v#.#.#'`
-
-12. Push the branch to the `traderinteractive/tide-design-system` repository:
-
-   `git push upstream v#.#.#`
-
-13. Open a [pull request](https://github.com/traderinteractive/tide-design-system/compare) in GitHub from the release branch to the `main` branch.
-14. Create a [milestone](https://github.com/traderinteractive/tide-design-system/milestones) in GitHub based on the alphanumeric version.
-   1. Assign milestone to the pull request for the release.
-   2. Assign milestone to all merged pull requests since previous release.
-15. Merge the pull request.
-    1.  Source branch will be removed from Github automatically.
-16. From local TIDE clone, check out the new commit from the trunk:
-
-    `npm checkout upstream/main`
-
-17. Deploy to Netlify:
-
-    `git push origin main`
-
-18. Generate distribution files:
-
-    `npm build`
-
-19. Publish (RESTRICTED)
-
-    `npm publish`

package/docs/figma.md

@@ -1,43 +0,0 @@
-# TIDE Figma
-
-## Workflow
-
-All Jira tickets with frontend changes should adhere to the following process:
-
-1. The designer should make a branch from the current state of the Figma project and make the necessary modifications leveraging the existing tokens and components wherever possible.
-2. Prior to development, the Figma branch should be reviewed, approved, and merged by the TIDE team in conjunction with the Director of Product Design.
-3. The "Designer" field of the Jira ticket should indicate the design resource assigned to the task. The designer is an equal contributor to the product triad and should be involved in all conversations about evolving frontend requirements.
-4. The URL for the relevant portion(s) of the Figma mock should be provided in the Jira ticket description.
-
-## How to read the Figma
-
-1. If correctly implemented, Figma designs should reflect standard tokens and components that correspond to code structures that can be leveraged to implement the design quickly and easily in code.
-   1. [Foundations](https://www.figma.com/design/9oYSAyY2X9mPaUMiobZOPg/Design-System---TIDE-2.0?node-id=3-3118&p=f&m=dev) should correspond to CSS utilities in the TIDE repository.
-   2. [Basic Components](https://www.figma.com/design/9oYSAyY2X9mPaUMiobZOPg/Design-System---TIDE-2.0?node-id=4-3140&p=f&m=dev) should correspond to Vue 3 components in the TIDE repository.
-   3. [Complex Components](https://www.figma.com/design/9oYSAyY2X9mPaUMiobZOPg/Design-System---TIDE-2.0?node-id=8-14&p=f&m=dev) should correspond to Vue 3 components that leverage TIDE components to build custom features within a consumer repository.
-2. If designs deviate from the documented TIDE standards, the developer should consult with the leadership triad of their product team to maximize consistency and resuability, then resubmit for TIDE review.
-
-## Links
-- [TIDE 1.0](https://www.figma.com/design/PFLodBQswv35AvYNEK0rv1/TIDE-1.0?node-id=401-3973&p=f&m=dev) (deprecated)
-- [TIDE 2.0](https://www.figma.com/design/9oYSAyY2X9mPaUMiobZOPg/Design-System---TIDE-2.0?node-id=0-1&p=f&m=dev)
-- [Interactions](https://www.figma.com/design/O0HapROvypnCHahGDMyoJq/Interactions---TIDE-2.0?node-id=0-1&p=f&m=dev)
-- Realm Libraries (color palette, etc.)
-  - [Aero](https://www.figma.com/design/UHmUU8P3FCfREv4SdOWt8L/Aero-Trader-Library---Web?node-id=1-216&p=f&m=dev)
-  - [ATV](https://www.figma.com/design/J5uusYhIq1GKrKpaUh4uGC/ATV-Trader-Library---Web?node-id=91-22&m=dev)
-  - [Boatmart](https://www.figma.com/design/hZ6xlyXOSJQdUmZ1WOdjUa/Boatmart-Library---Web?node-id=2-9&p=f&m=dev)
-  - [Cycle](https://www.figma.com/design/tPHRaoCkP3MS0C6q4K0XuQ/Equipment-Trader-Library---Web?node-id=0-1&p=f&m=dev)
-  - [Equipment](https://www.figma.com/design/tPHRaoCkP3MS0C6q4K0XuQ/Equipment-Trader-Library---Web?node-id=0-1&p=f&m=dev)
-  - [PWC](https://www.figma.com/design/4BoMdEBqLTAVx0IOWDCpBT/PWC-Trader-Library---Web?node-id=0-1&p=f&m=dev)
-  - [RV](https://www.figma.com/design/LSJpTgYLwsXW96ZmUGDVHB/RV-Trader-Library---Web?node-id=2-9&p=f&m=dev)
-  - [Snow](https://www.figma.com/design/SxVJ74VAErFuBRHc6e7iTm/Snowmobile-Trader-Library---Web)
-  - [Truck](https://www.figma.com/design/kcmuhXLGfFelG7gj3ebQoT/Commercial-Truck-Trader-Library---Web?node-id=0-1&p=f&m=dev)
-- Realm mocks
-  - [Aero](https://www.figma.com/files/1343962252732090517/project/251440029/Aero-Trader?fuid=1208507152973260209)
-  - [ATV](https://www.figma.com/design/rt84qhxyzEMvLGovmNTZQK/ATV-Trader?node-id=0-1&p=f&m=dev)
-  - [Boatmart](https://www.figma.com/design/zwzKQtnJwfQAeUllHAn5jx/Boatmart-Redesign---TIDE-2.0?node-id=0-1&p=f&m=dev)
-  - [Cycle](https://www.figma.com/design/x7mySD8gH42Go6hASy2ul9/Cycle-Trader?node-id=0-1&p=f&m=dev)
-  - [Equipment](https://www.figma.com/design/McrrkfAtqY1BxKLcAsjBGa/Equipment-Trader?node-id=0-1&p=f&m=dev)
-  - [PWC](https://www.figma.com/design/KTxisNAv9E6UbkFXxP8gNx/PWC-PAA?node-id=29-929&p=f&m=dev)
-  - [RV](https://www.figma.com/design/MBAdyd0UBIRL75bxvgOBF8/RV-Trader?node-id=0-1&p=f&m=dev)
-  - [Snow](https://www.figma.com/design/l6xlDEnyREuK9uCBonwDVY/Snowmobile-Trader-PAA?node-id=25-944&p=f&m=dev)
-  - [Truck](https://www.figma.com/design/1daIdHURI0GkMjbEEjdurO/Commercial-Truck-Trader?node-id=0-1&p=f&m=dev)