@jaredreisinger/react-crossword
Version:
A flexible, responsive, and easy-to-use crossword component for React apps
32 lines (31 loc) • 1.3 kB
TypeScript
/// <reference types="react" />
import PropTypes from 'prop-types';
import type { Direction, EnhancedProps } from './types';
/**
* Renders an individual clue, with its number. Makes use of `CrosswordContext`
* to know whether to render as “highlighted” or not, and uses the theme to
* provide the highlighting color.
*/
declare function Clue({ direction, number, children, complete, correct, ...props }: EnhancedProps<typeof Clue.propTypes, {
/** direction of the clue: “across” or “down”; passed back in onClick */
direction: Direction;
}>): JSX.Element;
declare namespace Clue {
var propTypes: {
/** direction of the clue: "across" or "down"; passed back in onClick */
direction: PropTypes.Validator<string>;
/** number of the clue (the label shown); passed back in onClick */
number: PropTypes.Validator<string>;
/** clue text */
children: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
/** whether the answer/guess is complete */
complete: PropTypes.Requireable<boolean>;
/** whether the answer/guess is correct */
correct: PropTypes.Requireable<boolean>;
};
var defaultProps: {
complete: undefined;
correct: undefined;
};
}
export default Clue;