GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-09 00:19:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Move sorting types back to addons

Browse Source
This commit is contained in:
Tom Coleman 2021-09-06 12:13:30 +10:00
parent f18d3b911a
commit d31cca366c
2 changed files with 32 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
lib/addons/src/types.ts
View File

@ -1,7 +1,6 @@
import {
AnyFramework,
InputType,
Parameters,
StoryContext as StoryContextForFramework,
LegacyStoryFn as LegacyStoryFnForFramework,
PartialStoryFn as PartialStoryFnForFramework,
@ -27,7 +26,6 @@ export type {
StoryName,
StoryIdentifier,
ViewMode,
Parameters,
Args,
} from '@storybook/csf';
@ -35,6 +33,37 @@ export type ArgTypes<TArgs = Args> = {
[key in keyof Partial<TArgs>]: InputType;
};
export type Comparator<T> = ((a: T, b: T) => boolean) | ((a: T, b: T) => number);
export type StorySortMethod = 'configure' | 'alphabetical';
export interface StorySortObjectParameter {
method?: StorySortMethod;
order?: any[];
locales?: string;
includeNames?: boolean;
}
// The `any` here is the story store's `StoreItem` record. Ideally we should probably only
// pass a defined subset of that full data, but we pass it all so far :shrug:
export type StorySortComparator = Comparator<[StoryId, any, Parameters, Parameters]>;
export type StorySortParameter = StorySortComparator | StorySortObjectParameter;
export interface OptionsParameter extends Object {
storySort?: StorySortParameter;
theme?: {
base: string;
brandTitle?: string;
};
[key: string]: any;
}
export interface Parameters {
fileName?: string;
options?: OptionsParameter;
/** The layout property defines basic styles added to the preview body where the story is rendered. If you pass 'none', no styles are applied. */
layout?: 'centered' | 'fullscreen' | 'padded' | 'none';
docsOnly?: boolean;
[key: string]: any;
}
export type StoryContext = StoryContextForFramework<AnyFramework>;
export type StoryContextUpdate = Partial<StoryContext>;

14
lib/client-api/src/storySort.ts
View File

@ -1,16 +1,4 @@
import { StoryId, Parameters } from '@storybook/csf';
// TODO -- these types were moved from lib/addons
type Comparator<T> = ((a: T, b: T) => boolean) | ((a: T, b: T) => number);
type StorySortMethod = 'configure' | 'alphabetical';
interface StorySortObjectParameter {
method?: StorySortMethod;
order?: any[];
locales?: string;
includeNames?: boolean;
}
type StorySortComparator = Comparator<[StoryId, any, Parameters, Parameters]>;
import { StorySortComparator, StorySortObjectParameter } from '@storybook/addons';
const STORY_KIND_PATH_SEPARATOR = /\s*\/\s*/;