@iress-oss/ids-mcp-server 6.0.0-alpha.0 → 6.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. package/package.json +30 -29
  2. package/generated/docs/components-alert-docs.md +0 -702
  3. package/generated/docs/components-autocomplete-docs.md +0 -1433
  4. package/generated/docs/components-autocomplete-recipes-docs.md +0 -104
  5. package/generated/docs/components-badge-docs.md +0 -531
  6. package/generated/docs/components-button-docs.md +0 -1442
  7. package/generated/docs/components-buttongroup-docs.md +0 -748
  8. package/generated/docs/components-card-docs.md +0 -944
  9. package/generated/docs/components-checkbox-docs.md +0 -694
  10. package/generated/docs/components-checkboxgroup-docs.md +0 -1087
  11. package/generated/docs/components-checkboxgroup-recipes-docs.md +0 -119
  12. package/generated/docs/components-col-docs.md +0 -881
  13. package/generated/docs/components-container-docs.md +0 -123
  14. package/generated/docs/components-divider-docs.md +0 -576
  15. package/generated/docs/components-expander-docs.md +0 -594
  16. package/generated/docs/components-field-docs.md +0 -2007
  17. package/generated/docs/components-filter-docs.md +0 -1322
  18. package/generated/docs/components-hide-docs.md +0 -702
  19. package/generated/docs/components-icon-docs.md +0 -816
  20. package/generated/docs/components-image-docs.md +0 -493
  21. package/generated/docs/components-inline-docs.md +0 -2003
  22. package/generated/docs/components-input-docs.md +0 -867
  23. package/generated/docs/components-input-recipes-docs.md +0 -140
  24. package/generated/docs/components-inputcurrency-docs.md +0 -689
  25. package/generated/docs/components-inputcurrency-recipes-docs.md +0 -115
  26. package/generated/docs/components-introduction-docs.md +0 -450
  27. package/generated/docs/components-label-docs.md +0 -562
  28. package/generated/docs/components-link-docs.md +0 -586
  29. package/generated/docs/components-menu-docs.md +0 -1146
  30. package/generated/docs/components-menu-menuitem-docs.md +0 -739
  31. package/generated/docs/components-modal-docs.md +0 -1346
  32. package/generated/docs/components-panel-docs.md +0 -600
  33. package/generated/docs/components-placeholder-docs.md +0 -446
  34. package/generated/docs/components-popover-docs.md +0 -1529
  35. package/generated/docs/components-popover-recipes-docs.md +0 -211
  36. package/generated/docs/components-progress-docs.md +0 -568
  37. package/generated/docs/components-provider-docs.md +0 -160
  38. package/generated/docs/components-radio-docs.md +0 -563
  39. package/generated/docs/components-radiogroup-docs.md +0 -1153
  40. package/generated/docs/components-readonly-docs.md +0 -535
  41. package/generated/docs/components-richselect-docs.md +0 -5836
  42. package/generated/docs/components-row-docs.md +0 -2354
  43. package/generated/docs/components-select-docs.md +0 -940
  44. package/generated/docs/components-skeleton-docs.md +0 -597
  45. package/generated/docs/components-skeleton-recipes-docs.md +0 -76
  46. package/generated/docs/components-skiplink-docs.md +0 -587
  47. package/generated/docs/components-slideout-docs.md +0 -1036
  48. package/generated/docs/components-slider-docs.md +0 -828
  49. package/generated/docs/components-spinner-docs.md +0 -450
  50. package/generated/docs/components-stack-docs.md +0 -923
  51. package/generated/docs/components-table-ag-grid-docs.md +0 -1444
  52. package/generated/docs/components-table-docs.md +0 -2327
  53. package/generated/docs/components-tabset-docs.md +0 -768
  54. package/generated/docs/components-tabset-tab-docs.md +0 -550
  55. package/generated/docs/components-tag-docs.md +0 -548
  56. package/generated/docs/components-text-docs.md +0 -585
  57. package/generated/docs/components-toaster-docs.md +0 -755
  58. package/generated/docs/components-toggle-docs.md +0 -614
  59. package/generated/docs/components-tooltip-docs.md +0 -747
  60. package/generated/docs/components-validationmessage-docs.md +0 -1161
  61. package/generated/docs/contact-us-docs.md +0 -27
  62. package/generated/docs/extensions-editor-docs.md +0 -1181
  63. package/generated/docs/extensions-editor-recipes-docs.md +0 -89
  64. package/generated/docs/foundations-accessibility-docs.md +0 -40
  65. package/generated/docs/foundations-consistency-docs.md +0 -52
  66. package/generated/docs/foundations-content-docs.md +0 -23
  67. package/generated/docs/foundations-grid-docs.md +0 -74
  68. package/generated/docs/foundations-introduction-docs.md +0 -19
  69. package/generated/docs/foundations-principles-docs.md +0 -70
  70. package/generated/docs/foundations-responsive-breakpoints-docs.md +0 -193
  71. package/generated/docs/foundations-tokens-colour-docs.md +0 -564
  72. package/generated/docs/foundations-tokens-elevation-docs.md +0 -155
  73. package/generated/docs/foundations-tokens-introduction-docs.md +0 -190
  74. package/generated/docs/foundations-tokens-radius-docs.md +0 -71
  75. package/generated/docs/foundations-tokens-spacing-docs.md +0 -89
  76. package/generated/docs/foundations-tokens-typography-docs.md +0 -322
  77. package/generated/docs/foundations-user-experience-docs.md +0 -63
  78. package/generated/docs/foundations-visual-design-docs.md +0 -46
  79. package/generated/docs/foundations-z-index-stacking-docs.md +0 -31
  80. package/generated/docs/frequently-asked-questions-docs.md +0 -53
  81. package/generated/docs/get-started-develop-docs.md +0 -209
  82. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  83. package/generated/docs/guidelines.md +0 -2054
  84. package/generated/docs/introduction-docs.md +0 -87
  85. package/generated/docs/news-version-6-docs.md +0 -93
  86. package/generated/docs/patterns-form-docs.md +0 -3902
  87. package/generated/docs/patterns-form-recipes-docs.md +0 -1370
  88. package/generated/docs/patterns-introduction-docs.md +0 -24
  89. package/generated/docs/patterns-loading-docs.md +0 -4043
  90. package/generated/docs/resources-code-katas-docs.md +0 -29
  91. package/generated/docs/resources-introduction-docs.md +0 -38
  92. package/generated/docs/resources-mcp-server-docs.md +0 -27
  93. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  94. package/generated/docs/styling-props-colour-docs.md +0 -172
  95. package/generated/docs/styling-props-elevation-docs.md +0 -88
  96. package/generated/docs/styling-props-radius-docs.md +0 -86
  97. package/generated/docs/styling-props-reference-docs.md +0 -160
  98. package/generated/docs/styling-props-screen-readers-docs.md +0 -71
  99. package/generated/docs/styling-props-sizing-docs.md +0 -627
  100. package/generated/docs/styling-props-spacing-docs.md +0 -2282
  101. package/generated/docs/styling-props-typography-docs.md +0 -121
  102. package/generated/docs/themes-available-themes-docs.md +0 -66
  103. package/generated/docs/themes-introduction-docs.md +0 -121
  104. package/generated/docs/versions-docs.md +0 -17
  105. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,140 +0,0 @@
1
- [](#recipes)Recipes
2
- ===================
3
-
4
- [](#percentage-formatting)Percentage formatting
5
- -----------------------------------------------
6
-
7
- You can use `IressInput` to display percentage formatting. When the field is focused, it can display the raw value, and when blurred, it can display the formatted percentage value.
8
-
9
- Feedback
10
-
11
- Hide code
12
-
13
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
14
-
15
- import { IressInput } from '@iress-oss/ids-components';
16
- export const InputPercentage \= () \=> (
17
- <IressInput<string | number\>
18
- defaultValue\="0.5"
19
- formatter\={(value \= '') \=> {
20
- if (value \=== '') return '';
21
- const numericValue \= Number(value);
22
- if (Number.isNaN(numericValue)) {
23
- return String(value) ?? '';
24
- }
25
- return new Intl.NumberFormat('en-AU', {
26
- style: 'percent',
27
- }).format(numericValue);
28
- }}
29
- type\="number"
30
- /\>
31
- );
32
-
33
- Copy
34
-
35
- [](#using-with-react-hook-forms)Using with React Hook Forms
36
- -----------------------------------------------------------
37
-
38
- You can use `IressInput` with React Hook Forms quite easily. The recommended way is to use the [`Controller` component from react-hook-forms](https://www.react-hook-form.com/get-started/#IntegratingwithUIlibraries). However, you can use the `register` method directly, with a few customisations to cater for custom `ref` as seen in the code example here.
39
-
40
- Where possible, please use `IressFormField` within an [`IressForm` component](./?path=/docs/components-form--docs).
41
-
42
- Although you can use `IressInput` directly with React Hook Forms, we recommend using `IressFormField` within `IressForm` for a more integrated experience.
43
-
44
- Input using `{ Controller } from 'react-hook-forms'`
45
-
46
- Input using `{ register } = useForm()`
47
-
48
- Submit
49
-
50
- Hide code
51
-
52
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
53
-
54
- import {
55
- InputRef,
56
- IressAlert,
57
- IressButton,
58
- IressInline,
59
- IressInput,
60
- IressLabel,
61
- IressModal,
62
- IressStack,
63
- IressTable,
64
- } from '@iress-oss/ids-components';
65
- import { useState } from 'react';
66
- import { Controller, UseFormRegisterReturn, useForm } from 'react-hook-form';
67
- const registerInnerElement \= (register: UseFormRegisterReturn) \=> {
68
- return {
69
- ...register,
70
- onClear: register.onChange,
71
- ref: (ref: InputRef | null) \=> {
72
- if (ref) {
73
- register.ref(ref.input);
74
- }
75
- },
76
- };
77
- };
78
- export const ReactHookFormsInput \= () \=> {
79
- const { register, handleSubmit, control } \= useForm();
80
- const \[data, setData\] \= useState<Record<string, string\> | undefined\>();
81
- return (
82
- // eslint-disable-next-line sonarjs/void-use -- This is a mock form submission
83
- <form onSubmit\={void handleSubmit(setData)}\>
84
- <IressStack gap\="md"\>
85
- <IressAlert status\="info"\>
86
- Although you can use <code\>IressInput</code\> directly with React Hook Forms, we recommend using <code\>IressFormField</code\> within{' '}
87
- <code\>IressForm</code\> for a more integrated experience. </IressAlert\>
88
- <IressInline gap\="md" verticalAlign\="middle"\>
89
- <IressLabel htmlFor\="Controller"\>
90
- Input using <code\>{\`{ Controller } from 'react-hook-forms'\`}</code\>
91
- </IressLabel\>
92
- <Controller
93
- name\="Controller"
94
- control\={control}
95
- render\={({ field }) \=> (
96
- <IressInput
97
- {...field}
98
- clearable
99
- onClear\={field.onChange}
100
- id\="firstName"
101
- />
102
- )}
103
- />
104
- </IressInline\>
105
- <IressInline gap\="md" verticalAlign\="middle"\>
106
- <IressLabel htmlFor\="register"\>
107
- Input using <code\>{\`{ register } = useForm()\`}</code\>
108
- </IressLabel\>
109
- <IressInput
110
- {...registerInnerElement(register('register'))}
111
- clearable
112
- id\="register"
113
- />
114
- </IressInline\>
115
- <IressButton type\="submit"\>Submit</IressButton\>
116
- </IressStack\>
117
- {data && (
118
- <IressModal
119
- show\={!!data}
120
- onShowChange\={(show) \=> !show && setData(undefined)}
121
- \>
122
- <IressTable
123
- caption\="Submitted details"
124
- rows\={Object.entries(data ?? {}).map((entry) \=> ({
125
- name: entry\[0\],
126
- value: JSON.stringify(entry\[1\], null, 2),
127
- }))}
128
- />
129
- </IressModal\>
130
- )}
131
- </form\>
132
- );
133
- };
134
-
135
- Copy
136
-
137
- On this page
138
-
139
- * [Percentage formatting](#percentage-formatting)
140
- * [Using with React Hook Forms](#using-with-react-hook-forms)