@simoncomputing/mui-bueno-v3 0.1.12 → 0.1.14

package/dist/components/Form/Inputs/Location/Location.d.ts

@@ -1,69 +0,0 @@
-import { TypographyProps } from '@mui/material';
-import { TextFieldProps } from '../TextField/TextField';
-import * as React from 'react';
-type BaseLocationProps = {
-    /**
-     * Name of the component. Must match the initialValue name in Formik.
-     * @required
-     */
-    name: string;
-    /**
-     * API Key. Needed for Location to work.
-     *
-     * NOTE: MAKE SURE TO TIE YOUR API KEY TO A DOMAIN TO ENSURE THE SECURITY OF YOUR KEY
-     * @required
-     */
-    apiKey: string;
-    /**
-     * The label for the text field.
-     * @recommended
-     * @default props.name
-     */
-    label?: string;
-    /**
-     * If true, the parts of the location suggestions that match the input are highlighted
-     * @default true
-     */
-    highlightMatches?: boolean;
-    /**
-     * The icon shown to the left of each location suggestion.
-     * Use false to indicate no icon
-     * @default <LocationOnIcon/>
-     */
-    resultIcon?: React.ReactElement | false;
-    /**
-     * If specified, restrict results from a Place Autocomplete request to be of a certain type.
-     * More information can be found [here](https://developers.google.com/places/supported_types#table3)
-     */
-    types?: 'geocode' | 'address' | 'establishment' | '(regions)' | '(cities)';
-    /**
-     * Specifies the visual input style.
-     * @default 'standard'
-     */
-    variant?: 'filled' | 'outlined' | 'standard';
-    /**
-     * If true, the prepackaged dynamic input label that comes with Material UI's input components
-     * will be replaced with a static typography label above the input.
-     * @default false
-     */
-    staticLabel?: boolean;
-    /**
-     * Props from MUI-Bueno's Typography component.
-     * Used to customize the label when the static label option is selected.
-     */
-    staticLabelProps?: TypographyProps;
-    /**
-     * Margin for the FormControl
-     */
-    margin?: 'dense' | 'none' | 'normal';
-};
-export type LocationProps = BaseLocationProps & TextFieldProps;
-/**
- * The `Location` component provides a Google Maps Places Autocomplete functionality to the Mui Bueno library.
- * It supplies a text field that upon input provides location suggestions.
- *
- * Note: You must have an active Google Maps API key to use this component. More information on creating API keys can be found
- * at the [Google Maps API documentation](https://developers.google.com/maps/documentation/javascript/get-api-key).
- */
-export declare const Location: React.FC<LocationProps>;
-export {};

package/dist/components/Form/Inputs/Location/Location.types.d.ts

@@ -1,85 +0,0 @@
-/**
- * Represents a prediction substring.
- *
- * **Props**
- * - `offset`
- *      - Type: `number`
- *      - The offset to the substring's start within the description string.
- * - `length`
- *      - Type: `number`
- *      - The length of the substring
- *
- * https://developers.google.com/maps/documentation/javascript/reference/places-autocomplete-service#PredictionSubstring
- */
-export type PredictionSubstring = google.maps.places.PredictionSubstring;
-/**
- * Structured information about the place's description, divided into a main text and a secondary text,
- * including an array of matched substrings from the autocomplete input,
- * identified by an offset and a length, expressed in unicode characters.
- *
- * **Props**
- * - `main_text`
- *      - Type: `string`
- *      - This is the main text part of the unformatted description of the place suggested
- *      by the Places service. Usually the name of the place.
- * - `secondary_text`
- *      - Type: `string`
- *      - This is the secondary text part of the unformatted description of the place suggested
- *      by the Places service. Usually the location of the place.
- * - `main_text_matched_substrings`
- *      - Type: `PredictionSubstring[]`
- *      - A set of substrings in the main text that match elements in the user's input, suitable for
- *      use in highlighting those substrings. Each substring is identified by an offset and a length,
- *      expressed in unicode characters.
- *
- * https://developers.google.com/maps/documentation/javascript/reference/places-autocomplete-service#StructuredFormatting
- */
-export type StructuredFormatting = google.maps.places.StructuredFormatting;
-/**
- * Represents a single autocomplete prediction.
- *
- * **Props**
- * - `description`
- *      - Type: `string`
- *      - This is the unformatted version of the query suggested by the Places service.
- * - `structured_formatting`
- *      - Type: `StructuredFormatting`
- *      - Structured information about the place's description
- * - `place_id`
- *      - Type: `string`
- *      - A place ID that can be used to retrieve details about this place using the place details service
- * - `matched_substrings`
- *      - Type: `PredictionSubstring[]`
- *      - A set of substrings in the place's description that match elements in the user's input,
- *      suitable for use in highlighting those substrings. Each substring is identified by an offset
- *      and a length, expressed in unicode characters.
- * - `terms`
- *      - Type: `PredictionTerm`
- *      - Information about individual terms in the above description, from most to least specific.
- *      For example, "Taco Bell", "Willitis", and "CA".
- * - `types`
- *      - Type: `string[]`
- *      - An array of types that the prediction belongs to, for example 'establishment' or 'geocode'.
- *
- * https://developers.google.com/maps/documentation/javascript/reference/places-autocomplete-service#AutocompletePrediction
- */
-export type AutocompletePrediction = google.maps.places.AutocompletePrediction;
-/**
- * Request for fetching AutocompletePredictions
- */
-export interface FetchRequest {
-    /**
-     * Text input from autocomplete field
-     * @required
-     */
-    input: string;
-    /**
-     * Acceptable address types for returning responses
-     * @required
-     */
-    types: string[];
-}
-/**
- * Callback function for fetching AutocompletePredictions
- */
-export type FetchCallback = (results?: AutocompletePrediction[] | null) => void;

package/dist/components/Form/Inputs/Location/LocationOption.d.ts

@@ -1,38 +0,0 @@
-import { AutocompletePrediction } from './Location.types';
-import * as React from 'react';
-interface LocationOptionProps {
-    /**
-     * Props for list item that wraps custom contents
-     * @required
-     */
-    listItemProps: React.HTMLAttributes<HTMLLIElement>;
-    /**
-     * Definition of PlaceType option being rendered in list item
-     * @required
-     */
-    option: AutocompletePrediction;
-    /**
-     * Icon to render on far left of list item
-     * @required
-     */
-    resultIcon: React.ReactElement | false;
-    /**
-     * Indicates to highlight text in option that matches textfield input
-     * @required
-     */
-    highlightMatches: boolean;
-}
-/**
- * Function to render custom location list items in the Autocomplete menu
- *
- * **Required Props**
- * - `listItemProps` - Props for list item that wraps custom contents
- * - `option` - Definition of PlaceType option being rendered in list item
- * - `resultIcon` - Icon to render on far left of list item
- * - `highlightMatches` - Indicates to highlight text in option that matches textfield input
- *
- * @param props LocationOptionProps
- * @returns Custom autocomplete option
- */
-declare const LocationOption: React.FC<LocationOptionProps>;
-export default LocationOption;