@craftercms/studio-ui/components/Launcher/Launcher.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/// <reference types="react" />
import { SystemLinkId } from '../../utils/system';
import { WidgetDescriptor } from '../../models';
import TranslationOrText from '../../models/TranslationOrText';
import { SystemIconDescriptor } from '../SystemIcon';
export interface LauncherStateProps {
  open: boolean;
  anchor: string;
  sitesRailPosition?: 'left' | 'right' | 'hidden';
  closeButtonPosition?: 'left' | 'right';
  widgets: WidgetDescriptor[];
  /**
   * Whether to render the global nav before or after
   * the additional widgets coming from configuration
   **/
  globalNavigationPosition?: 'before' | 'after';
  siteCardMenuLinks?: Array<{
    title: TranslationOrText;
    systemLinkId: SystemLinkId;
    icon?: SystemIconDescriptor;
    permittedRoles?: string[];
  }>;
}
export declare function Launcher(props: LauncherStateProps): JSX.Element;
export default Launcher;