synapse-react-client
Version:
[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie
32 lines • 1.09 kB
TypeScript
import { TargetEnum } from '@/utils/html/TargetEnum';
/**
* Defines the configuration for a link that will be rendered in the card
*/
export type CardLink = ({
matchColumnName: string;
overrideValueWithRowID?: boolean;
isMarkdown: false;
tooltipText?: string;
target?: TargetEnum;
} & ({
baseURL: string;
URLColumnName: string;
/**
* Controls how the record identifier is appended to baseURL.
*
* - `'query-param'` (default): appends as a query string parameter, e.g.
* `/<baseURL>?<URLColumnName>=<value>`
* - `'path-segment'`: appends as a path segment, e.g.
* `/<baseURL>/<value>`
*
* Use `'path-segment'` for clean-URL detail pages that use React Router
* dynamic segments (`:param`) rather than `?param=` query strings.
*/
urlParamStyle?: 'query-param' | 'path-segment';
wrapValueWithParens?: boolean;
resolveEntityName?: boolean;
} | {
overrideLinkURLColumnName: string;
overrideLinkURLColumnTransform?: (columnValue: string) => string;
}));
//# sourceMappingURL=CardLink.d.ts.map