vuetifyjs / vuetifyjs/vuetify

[Documentation] Imports from the docs failing & missing TS decls.

Open
#14,875 0 comments 3 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

C: Transitions S: maybe T: documentation
Dominant language
TypeScript
Stars
41k
Forks
7.1k
Avg merge
1d 21h
Merged PRs (30d)
11

Description

Environment

Vuetify Version: 3.0.0-beta.0
Vue Version: 3.2.31
Browsers: Firefox 98.0, Google Chrome
OS: Linux x86_64

Steps to reproduce

I took a look at public APIs from the docs:

import { createSimpleTransition } from 'vuetify/lib/components/transitions/createTransition'
const myTransition = createSimpleTransition('my-transition')

createSimpleTransition was renamed createCssTransition

import { createVueI18nAdapter } from 'vuetify/locale/adapters/vue-i18n'

No typescript declarations available.

Expected Behavior
  • New exports should be:
import { createCssTransition, createJavascriptTransition } from 'vuetify/lib/components/transitions/createTransition.mjs'.
  • createJavascriptTransition should be documented

  • createVueI18nAdapter should be available in typescript declaration files

  • The package should publish (or re-export) declarations from components/transitions/createTransition.d.ts and locale/adapters/vue-i18n.d.ts. Having util/colors.d.ts would be nice too (even if it's no longer in the docs).

Actual Behavior

Export from the docs fail, missing typescript declarations.

Reproduction Link

https://next.vuetifyjs.com/en/styles/transitions/#create-your-own

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.