@namba_one/ui-kit-2 1.0.0

package/README.md

@@ -0,0 +1,62 @@
+# namba-one-uikit
+
+UI Kit на Vue 3 + TypeScript + Vite для проектов Namba One.
+
+## Стек
+
+- Vue 3
+- TypeScript
+- Vite
+- Pinia
+- SCSS/LESS
+- ESLint, Stylelint, Prettier
+
+## Структура проекта (FSD)
+
+- `src/shared` — общие компоненты, утилиты, типы
+- `src/entities` — бизнес-сущности
+- `src/features` — фичи (функциональные блоки)
+- `src/widgets` — виджеты (сложные UI-блоки)
+- `src/pages` — страницы
+- `src/app` — инициализация приложения, роутинг
+
+## Быстрый старт
+
+```bash
+npm install
+npm run dev
+```
+
+## Сборка
+
+```bash
+npm run build
+```
+
+## Линтинг и форматирование
+
+```bash
+npm run lint
+npm run lint:style
+npm run format
+```
+
+## Процесс релиза
+
+1. Сделать `npm run build`
+2. Убедиться, что нет различий между ветками фичи, main, production
+3. Сделать merge request из фичи в main ветку в gitlab
+4. Сделать merge request из main в production ветку
+5. Прогнать следующие команды:
+
+```bash
+git switch production
+npm run pre-release -- -m "fix: [text]"
+npm run semantic-release
+```
+
+## Pull/Merge Request
+
+- Описывать изменения в MR
+- Проверять прохождение линтеров и сборки
+- Следовать FSD-структуре при добавлении новых файлов

package/dist/index.d.ts

@@ -0,0 +1,304 @@
+import { App } from 'vue';
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { DefineComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { InjectionKey } from 'vue';
+import { Plugin as Plugin_2 } from 'vue';
+import { PropType } from 'vue';
+import { PublicProps } from 'vue';
+import { Ref } from 'vue';
+import { RendererElement } from 'vue';
+import { RendererNode } from 'vue';
+import { SvgName } from '~virtual/svg-component';
+import { VNode } from 'vue';
+
+declare const __VLS_component: DefineComponent<ButtonProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+click: (e: Event) => any;
+}, string, PublicProps, Readonly<ButtonProps> & Readonly<{
+onClick?: ((e: Event) => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+declare const __VLS_component_2: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+
+declare function __VLS_template_2(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+
+declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+
+declare type __VLS_TemplateResult_2 = ReturnType<typeof __VLS_template_2>;
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_2<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare const aligns: readonly ["left", "center", "right"];
+
+export declare const Button: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+
+export declare const ButtonBase: DefineComponent<ButtonBaseProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+click: (e: Event) => any;
+}, string, PublicProps, Readonly<ButtonBaseProps> & Readonly<{
+onClick?: ((e: Event) => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare type ButtonBaseEmits = {
+    (event: 'click', e: Event): void;
+};
+
+export declare type ButtonBaseProps = {
+    tag?: (typeof tags)[number];
+    href?: string;
+    type?: (typeof types)[number];
+    isLoading?: boolean;
+    isDisabled?: boolean;
+};
+
+export declare type ButtonProps = ButtonBaseProps & {
+    view: (typeof views)[number];
+    size: (typeof sizes)[number];
+    interactionType?: InteractionType;
+    radius?: (typeof radiusSize)[number];
+    iconLeft?: IconName;
+    iconRight?: IconName;
+    isWide?: boolean;
+};
+
+export declare const ButtonSkeleton: DefineComponent<ButtonSkeletonProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ButtonSkeletonProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare type ButtonSkeletonProps = {
+    size: (typeof sizes)[number];
+};
+
+declare const colors: readonly ["inherit", "base", "secondary", "brand-accent", "brand-market", "error", "success", "inverse", "inverse-secondary", "disable"];
+
+declare const colors_2: readonly ["brand-accent", "secondary", "base", "error", "success", "inverse", "green", "blue", "red", "disable"];
+
+export declare const Currency: {
+    readonly KGS: "KGS";
+};
+
+export declare type Currency = (typeof Currency)[keyof typeof Currency];
+
+declare type FontName = (typeof fonts)[number];
+
+declare const fonts: readonly ["titleHuge", "titleExtraLarge", "titleLarge", "titleLargeBold", "titleLargeHeavy", "titleLargeRegular", "titleMedium", "titleSmall", "titleSmallRegular", "titleExtraSmallBold", "titleExtraSmall", "headlineMedium", "headlineSmall", "subheadLarge", "subheadMedium", "subheadSmall", "body", "bodyMedium", "textLarge", "textMedium", "textSmall", "captionLarge", "captionMedium", "captionSmall"];
+
+declare type GlobalConfig = {
+    interactionType: InteractionType;
+};
+
+export declare const Icon: DefineComponent<IconBaseProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<IconBaseProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare type IconBaseProps = {
+    name: SvgName;
+    color: (typeof colors_2)[number];
+    size?: number | string;
+};
+
+export declare type IconName = SvgName;
+
+export declare const Loader: DefineComponent<LoaderProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<LoaderProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare type LoaderProps = {
+    view?: (typeof views_2)[number];
+    size?: (typeof sizes_2)[number];
+};
+
+declare const NambaOneUIKit: Plugin_2;
+export default NambaOneUIKit;
+
+declare const objectFitOptions: readonly ["cover", "contain"];
+
+declare const radiusSize: readonly ["m", "s"];
+
+declare const sizes: readonly ["xl", "l", "m", "s"];
+
+declare const sizes_2: readonly ["xs", "s", "m", "l", "xl"];
+
+declare const skeletonSizes: readonly ["title_huge", "title_large", "title_medium", "title_small", "title_extraSmall", "headline_small", "subhead_large", "text_small", "caption_small"];
+
+export declare const SkeletonWrapper: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+declare const tags: readonly ["button", "a", "span", "router-link"];
+
+declare const tags_2: readonly ["span", "p", "div", "h1", "h2", "h3", "h4", "h5", "h6"];
+
+export declare const TheImage: DefineComponent<TheImageProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<TheImageProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+
+export declare type TheImageProps = {
+    src: string;
+    alt: string;
+    width: string | number;
+    height: string | number;
+    objectFit: (typeof objectFitOptions)[number];
+    hasPlaceholder?: boolean;
+    hasPriority?: boolean;
+    isLayoutFill?: boolean;
+    hasMixBlendMode?: boolean;
+};
+
+export declare const ThePicture: DefineComponent<ThePictureProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ThePictureProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare type ThePictureProps = {
+    src: string;
+    alt: string;
+    width: string | number;
+    height: string | number;
+    objectFit: 'cover' | 'contain';
+    hasPriority?: boolean;
+};
+
+export declare const TheText: DefineComponent<TheTextProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<TheTextProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare type TheTextProps = {
+    testId?: string;
+    tag?: (typeof tags_2)[number];
+    name?: FontName;
+    align?: (typeof aligns)[number];
+    color?: (typeof colors)[number];
+    isEllipsis?: boolean;
+    numberOfLines?: number | string;
+    fontFamily?: 'SfProDisplay' | 'SFMono';
+};
+
+export declare const TheTextSkeleton: DefineComponent<TheTextSkeletonProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<TheTextSkeletonProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare type TheTextSkeletonProps = {
+    color: (typeof colors)[number];
+    size: (typeof skeletonSizes)[number];
+    widthRange?: [number, number];
+};
+
+export declare type Toast = {
+    icon?: Maybe<IconName>;
+    title: string;
+    timer?: number;
+    buttonText?: string;
+    onButtonClick?: () => void;
+};
+
+export declare const Toaster: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {
+rootRef: HTMLDivElement;
+toastersRef: HTMLDivElement[];
+}, HTMLDivElement>;
+
+export declare type ToastListItem = Toast & {
+    id: number;
+};
+
+export declare interface ToastService {
+    list: Ref<ToastListItem[]>;
+    pauseTimeouts(): void;
+    restartTimeouts(): void;
+    remove(id: number): void;
+    show(params: Toast | string): void;
+    showError(text?: string, icon?: IconName): void;
+    install(app: App): void;
+}
+
+export declare const toastService: ToastServiceImpl;
+
+declare class ToastServiceImpl implements ToastService {
+    list: Ref<{
+        icon?: Maybe<IconName> | undefined;
+        title: string;
+        timer?: number | undefined;
+        buttonText?: string | undefined;
+        onButtonClick?: (() => void) | undefined;
+        id: number;
+    }[], ToastListItem[] | {
+        icon?: Maybe<IconName> | undefined;
+        title: string;
+        timer?: number | undefined;
+        buttonText?: string | undefined;
+        onButtonClick?: (() => void) | undefined;
+        id: number;
+    }[]>;
+    private timeouts;
+    restartTimeouts(): void;
+    pauseTimeouts(): void;
+    remove(id: number): void;
+    show(params: Toast | string): void;
+    showError(text?: string, icon?: IconName): void;
+    install(app: App): void;
+}
+
+export declare const ToastServiceKey: InjectionKey<ToastService>;
+
+export declare const TransitionFade: DefineComponent<ExtractPropTypes<    {
+appear: {
+type: PropType<TransitionFadeProps["appear"]>;
+default: boolean;
+};
+mode: {
+type: PropType<TransitionFadeProps["mode"]>;
+default: string;
+};
+duration: {
+type: PropType<TransitionFadeProps["duration"]>;
+default: number;
+};
+}>, () => VNode<RendererNode, RendererElement, {
+[key: string]: any;
+}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+appear: {
+type: PropType<TransitionFadeProps["appear"]>;
+default: boolean;
+};
+mode: {
+type: PropType<TransitionFadeProps["mode"]>;
+default: string;
+};
+duration: {
+type: PropType<TransitionFadeProps["duration"]>;
+default: number;
+};
+}>> & Readonly<{}>, {
+duration: number | undefined;
+mode: "default" | "in-out" | "out-in" | undefined;
+appear: boolean | undefined;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+declare type TransitionFadeProps = {
+    appear?: boolean;
+    mode?: 'out-in' | 'in-out' | 'default';
+    duration?: number;
+};
+
+export declare const TransitionVisibilityToggle: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
+
+declare const types: readonly ["button", "submit"];
+
+export declare const useGlobalConfig: () => GlobalConfig;
+
+export declare const useGlobalConfigProvide: (config: Partial<GlobalConfig>) => void;
+
+declare const views: readonly ["primary", "tertiary", "outlineBase", "system", "brandOpacity", "secondary", "criticalOnSurface", "criticalOpacity", "onDarkPrimary", "base"];
+
+declare const views_2: readonly ["orange", "white", "black", "gray", "red"];
+
+export { }