# @types/jquery.flagstrap

> TypeScript definitions for jquery.flagstrap

Latest version **1.0.8** (published 2024-01-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/jquery.flagstrap
pnpm add @types/jquery.flagstrap
yarn add @types/jquery.flagstrap
bun add @types/jquery.flagstrap
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2024-01-30 |
| First published | 2016-10-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/jquery.flagstrap
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery.flagstrap
- npm.io page: https://npm.io/package/@types/jquery.flagstrap

## Dependencies (1)

- [@types/jquery](https://npm.io/package/@types/jquery.md) *

## Recent versions

- 1.0.8 (latest) — 2024-01-30
- 1.0.7 (ts4.5) — 2023-11-07
- 1.0.4 (ts4.3) — 2023-08-25
- 1.0.3 (ts3.6) — 2021-07-08
- 1.0.2 (ts2.3) — 2017-06-15
- 1.0.1 (ts2.0) — 2016-10-05
- 1.0.6 — 2023-10-18
- 1.0.5 — 2023-09-15

## README

# Installation
> `npm install --save @types/jquery.flagstrap`

# Summary
This package contains type definitions for jquery.flagstrap (https://github.com/blazeworx/flagstrap).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery.flagstrap.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery.flagstrap/index.d.ts)
````ts
/// <reference types="jquery" />

declare namespace jQueryFlagStrap {
    interface FlagStrapOptions {
        /**
         * Default: uniquely generated
         * the `name` attribute for the actual `select` input
         */
        inputName: string;
        /**
         * Default: uniquely generated
         * the `id` attribute for the actual `select` input
         */
        inputId?: string | undefined;
        /**
         * Default: "btn-md"
         * The bootstrap button size `class` for this drop down
         */
        buttonSize: string;
        /**
         * Default: "btn-default"
         * The bootstrap button type `class` for this drop down
         */
        buttonType: string;
        /**
         * Default: "20px"
         * The `margin` between `flag` and `text label`
         */
        labelMargin: string;
        /**
         * Default: false
         * Scrollable or full height drop down
         */
        scrollable: boolean;
        /**
         * Default: "250px"
         * `max-height` for the scrollable drop down
         */
        scrollableHeight?: string | undefined;
        /**
         * Default: (all)
         * Only show specific countries
         * Example:
         *
         * {"GB": "United Kingdom", "US": "United States"}
         *
         * will only show the USA and UK.
         */
        countries?: Object | undefined;
        /**
         * Default: {value: "", text: "Please select a country"}
         * Set the placeholder value and text. To disable the placeholder define as (boolean) false.
         */
        placeholder: boolean | FlagStrapPlaceholderOptions;
        /**
         * Default: null
         * This callback gets called each time the select is changed. It receives two parameters, the new value, and the select element.
         */
        onSelect?(value: any, element: any): void;
    }

    interface FlagStrapStatic {
        flagStrap?: void | undefined;
    }

    interface FlagStrapPlaceholderOptions {
        value: string;
        text: string;
    }
}

interface JQuery {
    /**
     * A lightwieght jQuery plugin for creating Bootstrap 3 compatible country select boxes with flags.
     */

    flagStrap(): void;
    flagStrap(options: jQueryFlagStrap.FlagStrapOptions): void;
}

````

### Additional Details
 * Last updated: Tue, 30 Jan 2024 21:35:45 GMT
 * Dependencies: [@types/jquery](https://npmjs.com/package/@types/jquery)

# Credits
These definitions were written by [Felipe de Sena Garcia](https://github.com/felipedgarcia).

---
_Source: https://npm.io/package/@types/jquery.flagstrap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._