UNPKG

@blueprintjs/core

Version:
123 lines (101 loc) 3.63 kB
/* * Copyright 2015 Palantir Technologies, Inc. All rights reserved. * Licensed under the BSD-3 License as modified (the “License”); you may obtain a copy * of the license at https://github.com/palantir/blueprint/blob/master/LICENSE * and https://github.com/palantir/blueprint/blob/master/PATENTS */ import * as React from "react"; import { Intent } from "./intent"; export type HTMLInputProps = React.HTMLProps<HTMLInputElement>; /** * A shared base interface for all Blueprint component props. */ export interface IProps { /** A space-delimited list of class names to pass along to a child element. */ className?: string; } export interface IIntentProps { /** Visual intent color to apply to element. */ intent?: Intent; } /** * Interface for a clickable action, such as a button or menu item. * These props can be spready directly to a `<Button>` or `<MenuItem>` element. */ export interface IActionProps extends IIntentProps, IProps { /** Whether this action is non-interactive. */ disabled?: boolean; /** Name of the icon (the part after `pt-icon-`) to add to the button. */ iconName?: string; /** Click event handler. */ onClick?: (event: React.MouseEvent<HTMLElement>) => void; /** Action text. */ text?: string; } /** Interface for a link, with support for customizing target window. */ export interface ILinkProps { /** Link URL. */ href?: string; /** Link target attribute. Use `"_blank"` to open in a new window. */ target?: string; } /** Interface for a controlled input. */ export interface IControlledProps { /** Initial value of the input, for uncontrolled usage. */ defaultValue?: string; /** Change event handler. Use `event.target.value` for new value. */ onChange?: React.FormEventHandler<HTMLElement>; /** Form value of the input, for controlled usage. */ value?: string; } /** * An interface for an option in a list, such as in a `<select>` or `RadioGroup`. * These props can be spread directly to an `<option>` or `<Radio>` element. */ export interface IOptionProps extends IProps { /** Whether this option is non-interactive. */ disabled?: boolean; /** Label text for this option. */ label: string; /** Value of this option. */ value: string; } /** A collection of curated prop keys used across our Components which are not valid HTMLElement props. */ const INVALID_PROPS = [ "active", "containerRef", "elementRef", "iconName", "inputRef", "intent", "loading", "leftIconName", "onChildrenMount", "onRemove", "rightElement", "rightIconName", "text", ]; /** * Typically applied to HTMLElements to filter out blacklisted props. When applied to a Component, * can filter props from being passed down to the children. Can also filter by a combined list of * supplied prop keys and the blacklist (only appropriate for HTMLElements). * @param props The original props object to filter down. * @param {string[]} invalidProps If supplied, overwrites the default blacklist. * @param {boolean} shouldMerge If true, will merge supplied invalidProps and blacklist together. */ export function removeNonHTMLProps( props: { [key: string]: any }, invalidProps = INVALID_PROPS, shouldMerge = false, ): { [key: string]: any } { if (shouldMerge) { invalidProps = invalidProps.concat(INVALID_PROPS); } return invalidProps.reduce((prev, curr) => { if (prev.hasOwnProperty(curr)) { delete (prev as any)[curr]; } return prev; }, { ...props }); }