Skip to content

Commit

Permalink
Merge pull request #4759 from primefaces/issue-4742
Browse files Browse the repository at this point in the history
New InputGroup Component
  • Loading branch information
tugcekucukoglu authored Nov 6, 2023
2 parents 2b268f9 + 5d8babd commit 96c0bab
Show file tree
Hide file tree
Showing 17 changed files with 348 additions and 0 deletions.
15 changes: 15 additions & 0 deletions components/lib/inputgroup/BaseInputGroup.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<script>
import BaseComponent from 'primevue/basecomponent';
import InputGroupStyle from 'primevue/inputgroup/style';
export default {
name: 'BaseInputGroup',
extends: BaseComponent,
style: InputGroupStyle,
provide() {
return {
$parentInstance: this
};
}
};
</script>
114 changes: 114 additions & 0 deletions components/lib/inputgroup/InputGroup.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
/**
*
* InputGroup displays text, icon, buttons and other content can be grouped next to an input.
*
* [Live Demo](https://www.primevue.org/inputgroup/)
*
* @module inputgroup
*
*/
import { VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';

export declare type InputGroupPassThroughOptionType = InputGroupPassThroughAttributes | ((options: InputGroupPassThroughMethodOptions) => InputGroupPassThroughAttributes | string) | string | null | undefined;

/**
* Custom passthrough(pt) option method.
*/
export interface InputGroupPassThroughMethodOptions {
/**
* Defines instance.
*/
instance: any;
/**
* Defines passthrough(pt) options in global config.
*/
global: object | undefined;
}

/**
* Custom passthrough(pt) options.
* @see {@link InputGroupProps.pt}
*/
export interface InputGroupPassThroughOptions {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: InputGroupPassThroughOptionType;
/**
* Used to manage all lifecycle hooks
* @see {@link BaseComponent.ComponentHooks}
*/
hooks?: ComponentHooks;
}

/**
* Custom passthrough attributes for each DOM elements
*/
export interface InputGroupPassThroughAttributes {
[key: string]: any;
}

/**
* Defines valid properties in InputGroup component.
*/
export interface InputGroupProps {
/**
* Used to pass attributes to DOM elements inside the component.
* @type {InputGroupPassThroughOptions}
*/
pt?: PassThrough<InputGroupPassThroughOptions>;
/**
* Used to configure passthrough(pt) options of the component.
* @type {PassThroughOptions}
*/
ptOptions?: PassThroughOptions;
/**
* When enabled, it removes component related styles in the core.
* @defaultValue false
*/
unstyled?: boolean;
}

/**
* Defines valid slots in InputGroup component.
*/
export interface InputGroupSlots {
/**
* Custom default template.
*/
default(): VNode[];
/**
* Dynamic content template.
* @todo
*/
[key: string]: (node: any) => VNode[];
}

/**
* Defines valid emits in InputGroup component.
*/
export interface InputGroupEmits {}

/**
* **PrimeVue - InputGroup**
*
* _InputGroup displays text, icon, buttons and other content can be grouped next to an input._
*
* [Live Demo](https://www.primevue.org/inputgroup/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
declare class InputGroup extends ClassComponent<InputGroupProps, InputGroupSlots, InputGroupEmits> {}

declare module '@vue/runtime-core' {
interface GlobalComponents {
InputGroup: GlobalComponentConstructor<InputGroup>;
}
}

export default InputGroup;
14 changes: 14 additions & 0 deletions components/lib/inputgroup/InputGroup.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<template>
<div :class="cx('root')" v-bind="ptm('root')" data-pc-name="inputgroup">
<slot />
</div>
</template>

<script>
import BaseInputGroup from './BaseInputGroup.vue';
export default {
name: 'InputGroup',
extends: BaseInputGroup
};
</script>
9 changes: 9 additions & 0 deletions components/lib/inputgroup/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"main": "./inputgroup.cjs.js",
"module": "./inputgroup.esm.js",
"unpkg": "./inputgroup.min.js",
"types": "./InputGroup.d.ts",
"browser": {
"./sfc": "./InputGroup.vue"
}
}
3 changes: 3 additions & 0 deletions components/lib/inputgroup/style/InputGroupStyle.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { BaseStyle } from '../../base/style';

export interface InputGroupStyle extends BaseStyle {}
10 changes: 10 additions & 0 deletions components/lib/inputgroup/style/InputGroupStyle.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import BaseStyle from 'primevue/base/style';

const classes = {
root: 'p-inputgroup'
};

export default BaseStyle.extend({
name: 'inputgroup',
classes
});
6 changes: 6 additions & 0 deletions components/lib/inputgroup/style/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"main": "./inputgroupstyle.cjs.js",
"module": "./inputgroupstyle.esm.js",
"unpkg": "./inputgroupstyle.min.js",
"types": "./InputGroupStyle.d.ts"
}
15 changes: 15 additions & 0 deletions components/lib/inputgroupaddon/BaseInputGroupAddon.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<script>
import BaseComponent from 'primevue/basecomponent';
import InputGroupAddonStyle from 'primevue/inputgroupaddon/style';
export default {
name: 'BaseInputGroupAddon',
extends: BaseComponent,
style: InputGroupAddonStyle,
provide() {
return {
$parentInstance: this
};
}
};
</script>
114 changes: 114 additions & 0 deletions components/lib/inputgroupaddon/InputGroupAddon.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
/**
*
* InputGroupAddon displays text, icon, buttons and other content can be grouped next to an input.
*
* [Live Demo](https://www.primevue.org/inputgroup/)
*
* @module inputgroupaddon
*
*/
import { VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';

export declare type InputGroupPassThroughOptionType = InputGroupPassThroughAttributes | ((options: InputGroupPassThroughMethodOptions) => InputGroupPassThroughAttributes | string) | string | null | undefined;

/**
* Custom passthrough(pt) option method.
*/
export interface InputGroupPassThroughMethodOptions {
/**
* Defines instance.
*/
instance: any;
/**
* Defines passthrough(pt) options in global config.
*/
global: object | undefined;
}

/**
* Custom passthrough(pt) options.
* @see {@link InputGroupProps.pt}
*/
export interface InputGroupPassThroughOptions {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: InputGroupPassThroughOptionType;
/**
* Used to manage all lifecycle hooks
* @see {@link BaseComponent.ComponentHooks}
*/
hooks?: ComponentHooks;
}

/**
* Custom passthrough attributes for each DOM elements
*/
export interface InputGroupPassThroughAttributes {
[key: string]: any;
}

/**
* Defines valid properties in InputGroupAddon component.
*/
export interface InputGroupProps {
/**
* Used to pass attributes to DOM elements inside the component.
* @type {InputGroupPassThroughOptions}
*/
pt?: PassThrough<InputGroupPassThroughOptions>;
/**
* Used to configure passthrough(pt) options of the component.
* @type {PassThroughOptions}
*/
ptOptions?: PassThroughOptions;
/**
* When enabled, it removes component related styles in the core.
* @defaultValue false
*/
unstyled?: boolean;
}

/**
* Defines valid slots in InputGroupAddon component.
*/
export interface InputGroupSlots {
/**
* Custom default template.
*/
default(): VNode[];
/**
* Dynamic content template.
* @todo
*/
[key: string]: (node: any) => VNode[];
}

/**
* Defines valid emits in InputGroupAddon component.
*/
export interface InputGroupEmits {}

/**
* **PrimeVue - InputGroupAddon**
*
* _InputGroup displays text, icon, buttons and other content can be grouped next to an input._
*
* [Live Demo](https://www.primevue.org/inputgroup/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
declare class InputGroupAddon extends ClassComponent<InputGroupProps, InputGroupSlots, InputGroupEmits> {}

declare module '@vue/runtime-core' {
interface GlobalComponents {
InputGroupAddon: GlobalComponentConstructor<InputGroupAddon>;
}
}

export default InputGroupAddon;
14 changes: 14 additions & 0 deletions components/lib/inputgroupaddon/InputGroupAddon.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<template>
<div :class="cx('root')" v-bind="ptm('root')" data-pc-name="inputgroupaddon">
<slot />
</div>
</template>

<script>
import BaseInputGroupAddon from './BaseInputGroupAddon.vue';
export default {
name: 'InputGroupAddon',
extends: BaseInputGroupAddon
};
</script>
9 changes: 9 additions & 0 deletions components/lib/inputgroupaddon/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"main": "./inputgroupaddon.cjs.js",
"module": "./inputgrouaddonp.esm.js",
"unpkg": "./inputgroupaddon.min.js",
"types": "./InputGroupAddon.d.ts",
"browser": {
"./sfc": "./InputGroupAddon.vue"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { BaseStyle } from '../../base/style';

export interface InputGroupAddonStyle extends BaseStyle {}
10 changes: 10 additions & 0 deletions components/lib/inputgroupaddon/style/InputGroupAddonStyle.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import BaseStyle from 'primevue/base/style';

const classes = {
root: 'p-inputgroup-addon'
};

export default BaseStyle.extend({
name: 'inputgroupaddon',
classes
});
6 changes: 6 additions & 0 deletions components/lib/inputgroupaddon/style/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"main": "./inputgroupaddonstyle.cjs.js",
"module": "./inputgroupaddonstyle.esm.js",
"unpkg": "./inputgroupaddonstyle.min.js",
"types": "./InputGroupAddonStyle.d.ts"
}
2 changes: 2 additions & 0 deletions modules/nuxt-primevue/runtime/core/components/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ const form = [
'ColorPicker',
'Dropdown',
'Editor',
'InputGroup',
'InputGroupAddon',
'InputMask',
'InputNumber',
'InputSwitch',
Expand Down
2 changes: 2 additions & 0 deletions nuxt-vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ const STYLE_ALIAS = {
'primevue/image/style': path.resolve(__dirname, './components/lib/image/style/ImageStyle.js'),
'primevue/inlinemessage/style': path.resolve(__dirname, './components/lib/inlinemessage/style/InlineMessageStyle.js'),
'primevue/inplace/style': path.resolve(__dirname, './components/lib/inplace/style/InplaceStyle.js'),
'primevue/inputgroup/style': path.resolve(__dirname, './components/lib/inputgroup/style/InputGroupStyle.js'),
'primevue/inputgroupaddon/style': path.resolve(__dirname, './components/lib/inputgroupaddon/style/InputGroupAddonStyle.js'),
'primevue/inputmask/style': path.resolve(__dirname, './components/lib/inputmask/style/InputMaskStyle.js'),
'primevue/inputnumber/style': path.resolve(__dirname, './components/lib/inputnumber/style/InputNumberStyle.js'),
'primevue/inputswitch/style': path.resolve(__dirname, './components/lib/inputswitch/style/InputSwitchStyle.js'),
Expand Down
2 changes: 2 additions & 0 deletions rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ const CORE_STYLE_DEPENDENCIES = {
'primevue/image/style': 'primevue.image.style',
'primevue/inlinemessage/style': 'primevue.inlinemessage.style',
'primevue/inplace/style': 'primevue.inplace.style',
'primevue/inputgroup/style': 'primevue.inputgroup.style',
'primevue/inputgroupaddon/style': 'primevue.inputgroupaddon.style',
'primevue/inputmask/style': 'primevue.inputmask.style',
'primevue/inputnumber/style': 'primevue.inputnumber.style',
'primevue/inputswitch/style': 'primevue.inputswitch.style',
Expand Down

0 comments on commit 96c0bab

Please sign in to comment.