Named easings are exported but not documented

Aperta
  • Qualcosa non va?
#183 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
css, typescript
Ambito
api, documentation

Direzione di ricerca

Ispeziona gli export del runtime di @wix/motion, la documentazione README/API pubblicata e le dichiarazioni TypeScript, quindi controlla le definizioni dei tipi delle regole preset per i campi easing. Documenta cssEasings e le sue chiavi, esponi il tipo named-easing e fai in modo che i tipi easing dei preset vi facciano riferimento; il lavoro è completato quando i consumer possono trovare e completare automaticamente i nomi supportati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug

Describe the bug

@wix/motion exports a cssEasings object (a map of ~30 named easings to their cubic-bezier(…) values), but it is not documented, its keys are not exposed as a TypeScript type, and preset rule types use easing?: string rather than referencing a named-easing union. Consumers can only discover it by guessing the import exists.

// This works at runtime but is undocumented and untyped:
import { cssEasings } from '@wix/motion';

console.log(cssEasings);
// { linear: '...', ease: '...', easeInQuad: '...', easeOutCubic: '...', … }

// No exported type for the key set — have to derive it ourselves:
type CssEasingName = keyof typeof cssEasings;

// Preset easing fields accept these names but are typed as `string`:
const timing: EffectTiming = { easing: 'easeInQuad' }; // no autocomplete, no validation

To Reproduce

  1. Install @wix/[email protected]
  2. Search the published README / API docs for "cssEasings" or "named easings" — no results
  3. Open node_modules/@wix/motion type declarations — no CssEasingName or equivalent union type is exported
  4. Try typing easing: '...' in a preset config — get string, no autocomplete for valid easing names
  5. Discover cssEasings only by browsing the package's runtime exports or source

Expected behavior

  • cssEasings is documented as a public export with its keys listed
  • A union type (e.g. CssEasingName) is exported so consumers can type easing parameters against the known set
  • Preset rule types for easing fields reference that union (or at minimum document that named easing strings from cssEasings are accepted)

Screenshots

N/A — this is a docs/types gap, not a visual bug.

Desktop

  • OS: macOS 15.4
  • @wix/motion: 2.1.3
  • @wix/motion-presets: 1.0.0
  • TypeScript: 5.x

Additional context

Any tool that builds an easing picker (dropdown, autocomplete, curve preview) needs the canonical set of named easings. Currently this requires guessing the undocumented export exists, then deriving the key set at runtime. There is no compile-time safety when passing easing names to preset configs. A workaround:

import { cssEasings } from '@wix/motion';

const NAMED_EASINGS = Object.keys(cssEasings).map(name => ({
  value: name,
  label: name.replace(/([a-z])([A-Z])/g, '$1 $2'),
}));
Lingua principale
TypeScript
Stelle
4
Fork
3
Merge medio
11h 45m
PR unite (30g)
55

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di wix/interact

Tutte le issue di wix/interact

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.