@craftercms/studio-ui/utils/contentType.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/>.
 */

import ContentType, { ContentTypeField } from '../models/ContentType';
import LookupTable from '../models/LookupTable';
import { darken } from '@mui/material/styles';
import { Theme } from '@mui/material';
export declare function getRelatedContentTypeIds(contentType: ContentType): string[];
export declare function isGroupItem(contentType: ContentType, fieldId: string): boolean;
export declare function isComponentHolder(contentType: ContentType, fieldId: string): boolean;
export declare function isGroup(contentType: ContentType, fieldId: string): boolean;
export declare function doesFieldAccept(contentType: ContentType, fieldId: string): void;
export declare function getField(
  type: ContentType,
  fieldId: string,
  contentTypes?: LookupTable<ContentType>
): ContentTypeField;
export declare function getFields(type: ContentType, ...ids: string[]): ContentTypeField[];
export declare function getFieldsByType(contentType: ContentType, fieldType: any): ContentTypeField[];
export declare function getDefaultValue(field: ContentTypeField): string | number | boolean | any[];
/**
 * It takes a string and generates a colour and contrast colour for it.
 * Applies a darkening effect when the theme is dark.
 */
export declare function getAvatarWithIconColors(
  colourBaseString: string,
  theme: Theme,
  darkenFn: typeof darken
): {
  backgroundColor: string;
  textColor: string;
};