-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathb3d1da45.61afb415.js
1 lines (1 loc) · 12.7 KB
/
b3d1da45.61afb415.js
1
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[5391],{1308:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"vue-intl","title":"Vue Plugin for formatjs","description":"This library contains our plugin for Vue.","source":"@site/docs/vue-intl.md","sourceDirName":".","slug":"/vue-intl","permalink":"/docs/vue-intl","draft":false,"unlisted":false,"editUrl":"https://github.com/formatjs/formatjs/edit/main/website/docs/vue-intl.md","tags":[],"version":"current","lastUpdatedBy":"renovate[bot]","lastUpdatedAt":1743439950000,"frontMatter":{"id":"vue-intl","title":"Vue Plugin for formatjs"},"sidebar":"api","previous":{"title":"Core FormatJS Intl","permalink":"/docs/intl"},"next":{"title":"Intl MessageFormat","permalink":"/docs/intl-messageformat"}}');var l=t(6106),s=t(7389),a=t(9179),i=t(2597);const o={id:"vue-intl",title:"Vue Plugin for formatjs"},c=void 0,u={},d=[{value:"Installation",id:"installation",level:2},{value:"Usage",id:"usage",level:2},{value:"inject",id:"inject",level:3},{value:"Composition API",id:"composition-api",level:3},{value:"Methods",id:"methods",level:3},{value:"Tooling",id:"tooling",level:2},{value:"Caveats",id:"caveats",level:2},{value:"Using ICU in Vue SFC",id:"using-icu-in-vue-sfc",level:3}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.p,{children:"This library contains our plugin for Vue."}),"\n",(0,l.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n","\n",(0,l.jsxs)(a.A,{groupId:"npm",defaultValue:"npm",values:[{label:"npm",value:"npm"},{label:"yarn",value:"yarn"}],children:[(0,l.jsx)(i.A,{value:"npm",children:(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-sh",children:"npm i -S vue-intl\n"})})}),(0,l.jsx)(i.A,{value:"yarn",children:(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-sh",children:"yarn add vue-intl\n"})})})]}),"\n",(0,l.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,l.jsxs)(n.p,{children:["Initialize ",(0,l.jsx)(n.code,{children:"VueIntl"})," plugin with the same ",(0,l.jsx)(n.code,{children:"IntlConfig"})," documented in ",(0,l.jsx)(n.a,{href:"/docs/intl#IntlShape",children:"@formatjs/intl"}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",children:"import {createIntl} from 'vue-intl'\n\nconst app = createApp(App)\napp.use(\n createIntl({\n locale: 'en',\n defaultLocale: 'en',\n messages: {\n foo: 'bar',\n },\n })\n)\n"})}),"\n",(0,l.jsx)(n.p,{children:"From there you can use our APIs in 2 ways:"}),"\n",(0,l.jsx)(n.h3,{id:"inject",children:"inject"}),"\n",(0,l.jsxs)(n.p,{children:["By specifying ",(0,l.jsx)(n.code,{children:"inject: {intl: intlKey}"}),", you can use the full ",(0,l.jsx)(n.code,{children:"IntlFormatters"})," API documented in ",(0,l.jsx)(n.a,{href:"/docs/intl#IntlShape",children:"@formatjs/intl"}),"."]}),"\n",(0,l.jsxs)(n.p,{children:["Note: ",(0,l.jsx)(n.code,{children:"intlKey"})," needs to be imported from ",(0,l.jsx)(n.code,{children:"vue-intl"}),"."]}),"\n",(0,l.jsx)(n.h3,{id:"composition-api",children:"Composition API"}),"\n",(0,l.jsxs)(n.p,{children:["We also support Vue's ",(0,l.jsx)(n.a,{href:"https://composition-api.vuejs.org/",children:"Composition API"})," with ",(0,l.jsx)(n.code,{children:"provideIntl"})," & ",(0,l.jsx)(n.code,{children:"useIntl"}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import {createIntl} from '@formatjs/intl'\nimport {provideIntl, useIntl} from 'vue-intl'\n\nconst Ancestor = {\n setup() {\n provideIntl(\n createIntl({\n locale: 'en',\n defaultLocale: 'en',\n messages: {\n foo: 'Composed',\n },\n })\n )\n },\n render() {\n return h(Descendant)\n },\n}\n\nconst Descendant = {\n setup() {\n const intl = useIntl()\n return () =>\n h(\n 'p',\n {},\n intl.formatMessage({\n id: 'foo',\n defaultMessage: 'Hello',\n })\n )\n },\n}\n"})}),"\n",(0,l.jsx)(n.h3,{id:"methods",children:"Methods"}),"\n",(0,l.jsxs)(n.p,{children:["You can also use our formatters in Vue template by prepending ",(0,l.jsx)(n.code,{children:"$"})," like below:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-vue",children:"<template>\n <p>{{ $formatNumber(3, {style: 'currency', currency: 'USD'}) }}</p>\n</template>\n"})}),"\n",(0,l.jsx)(n.p,{children:"We currently support:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.code,{children:"$formatMessage"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.code,{children:"$formatDate"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.code,{children:"$formatTime"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.code,{children:"$formatRelativeTime"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.code,{children:"$formatTimeRange"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.code,{children:"$formatDisplayName"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.code,{children:"$formatList"})}),"\n"]}),"\n",(0,l.jsxs)(n.p,{children:["See ",(0,l.jsx)(n.a,{href:"/docs/intl",children:"@formatjs/intl"})," for the full list of API signatures."]}),"\n",(0,l.jsx)(n.h2,{id:"tooling",children:"Tooling"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"formatjs"})," toolchain fully supports ",(0,l.jsx)(n.code,{children:"vue"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.a,{href:"/docs/tooling/linter",children:"eslint-plugin-formatjs"}),": This fully supports ",(0,l.jsx)(n.code,{children:".vue"})," and JS/TS."]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.a,{href:"/docs/tooling/cli",children:"@formatjs/cli"}),": We now support extracting messages from ",(0,l.jsx)(n.code,{children:".vue"})," SFC files."]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.a,{href:"/docs/tooling/babel-plugin",children:"babel-plugin-formatjs"}),": Compile messages during bundling for ",(0,l.jsx)(n.code,{children:"babel"}),"."]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.a,{href:"/docs/tooling/ts-transformer",children:"@formatjs/ts-transformer"}),": Compile messages during bundling for ",(0,l.jsx)(n.code,{children:"TypeScript"}),"."]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"caveats",children:"Caveats"}),"\n",(0,l.jsx)(n.h3,{id:"using-icu-in-vue-sfc",children:"Using ICU in Vue SFC"}),"\n",(0,l.jsxs)(n.p,{children:["Since ",(0,l.jsx)(n.code,{children:"}}"})," & ",(0,l.jsx)(n.code,{children:"{{"})," are special tokens in ",(0,l.jsx)(n.code,{children:".vue"})," ",(0,l.jsx)(n.code,{children:"<template>"}),", this can cause potential conflict with ICU MessageFormat syntax, e.g:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-html",metastring:"{4}",children:"<template>\n <p>\n {{ $formatMessage({ defaultMessage: '{count, selectordinal, offset:1 one {#}\n other {# more}}', }) }}\n </p>\n</template>\n"})}),"\n",(0,l.jsxs)(n.p,{children:["Notice the ",(0,l.jsx)(n.code,{children:"{# more}}"})," where it ends with ",(0,l.jsx)(n.code,{children:"}}"}),". This will cause parsing issue in your ",(0,l.jsx)(n.code,{children:"vue"})," template. In order to work around this issue, we recommend using space to turn ",(0,l.jsx)(n.code,{children:"}}"})," into ",(0,l.jsx)(n.code,{children:"} }"}),"."]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-vue",metastring:"{6}",children:"<template>\n <p>\n {{\n $formatMessage({\n defaultMessage:\n '{count, selectordinal, offset:1 one {#} other {# more} }',\n })\n }}\n </p>\n</template>\n"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(h,{...e})}):h(e)}},2597:(e,n,t)=>{t.d(n,{A:()=>a});t(7378);var r=t(3372);const l={tabItem:"tabItem_bSYy"};var s=t(6106);function a(e){let{children:n,hidden:t,className:a}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,r.A)(l.tabItem,a),hidden:t,children:n})}},9179:(e,n,t)=>{t.d(n,{A:()=>I});var r=t(7378),l=t(3372),s=t(2214),a=t(1654),i=t(8970),o=t(3067),c=t(5512),u=t(3798);function d(e){return r.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,r.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad <Tabs> child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function h(e){const{values:n,children:t}=e;return(0,r.useMemo)((()=>{const e=n??function(e){return d(e).map((e=>{let{props:{value:n,label:t,attributes:r,default:l}}=e;return{value:n,label:t,attributes:r,default:l}}))}(t);return function(e){const n=(0,c.XI)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in <Tabs>. Every value needs to be unique.`)}(e),e}),[n,t])}function p(e){let{value:n,tabValues:t}=e;return t.some((e=>e.value===n))}function m(e){let{queryString:n=!1,groupId:t}=e;const l=(0,a.W6)(),s=function(e){let{queryString:n=!1,groupId:t}=e;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!t)throw new Error('Docusaurus error: The <Tabs> component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:n,groupId:t});return[(0,o.aZ)(s),(0,r.useCallback)((e=>{if(!s)return;const n=new URLSearchParams(l.location.search);n.set(s,e),l.replace({...l.location,search:n.toString()})}),[s,l])]}function f(e){const{defaultValue:n,queryString:t=!1,groupId:l}=e,s=h(e),[a,o]=(0,r.useState)((()=>function(e){let{defaultValue:n,tabValues:t}=e;if(0===t.length)throw new Error("Docusaurus error: the <Tabs> component requires at least one <TabItem> children component");if(n){if(!p({value:n,tabValues:t}))throw new Error(`Docusaurus error: The <Tabs> has a defaultValue "${n}" but none of its children has the corresponding value. Available values are: ${t.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return n}const r=t.find((e=>e.default))??t[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:n,tabValues:s}))),[c,d]=m({queryString:t,groupId:l}),[f,j]=function(e){let{groupId:n}=e;const t=function(e){return e?`docusaurus.tab.${e}`:null}(n),[l,s]=(0,u.Dv)(t);return[l,(0,r.useCallback)((e=>{t&&s.set(e)}),[t,s])]}({groupId:l}),x=(()=>{const e=c??f;return p({value:e,tabValues:s})?e:null})();(0,i.A)((()=>{x&&o(x)}),[x]);return{selectedValue:a,selectValue:(0,r.useCallback)((e=>{if(!p({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);o(e),d(e),j(e)}),[d,j,s]),tabValues:s}}var j=t(6338);const x={tabList:"tabList_vHwT",tabItem:"tabItem_YHOU"};var g=t(6106);function v(e){let{className:n,block:t,selectedValue:r,selectValue:a,tabValues:i}=e;const o=[],{blockElementScrollPositionUntilNextRender:c}=(0,s.a_)(),u=e=>{const n=e.currentTarget,t=o.indexOf(n),l=i[t].value;l!==r&&(c(n),a(l))},d=e=>{let n=null;switch(e.key){case"Enter":u(e);break;case"ArrowRight":{const t=o.indexOf(e.currentTarget)+1;n=o[t]??o[0];break}case"ArrowLeft":{const t=o.indexOf(e.currentTarget)-1;n=o[t]??o[o.length-1];break}}n?.focus()};return(0,g.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,l.A)("tabs",{"tabs--block":t},n),children:i.map((e=>{let{value:n,label:t,attributes:s}=e;return(0,g.jsx)("li",{role:"tab",tabIndex:r===n?0:-1,"aria-selected":r===n,ref:e=>{o.push(e)},onKeyDown:d,onClick:u,...s,className:(0,l.A)("tabs__item",x.tabItem,s?.className,{"tabs__item--active":r===n}),children:t??n},n)}))})}function b(e){let{lazy:n,children:t,selectedValue:s}=e;const a=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){const e=a.find((e=>e.props.value===s));return e?(0,r.cloneElement)(e,{className:(0,l.A)("margin-top--md",e.props.className)}):null}return(0,g.jsx)("div",{className:"margin-top--md",children:a.map(((e,n)=>(0,r.cloneElement)(e,{key:n,hidden:e.props.value!==s})))})}function y(e){const n=f(e);return(0,g.jsxs)("div",{className:(0,l.A)("tabs-container",x.tabList),children:[(0,g.jsx)(v,{...n,...e}),(0,g.jsx)(b,{...n,...e})]})}function I(e){const n=(0,j.A)();return(0,g.jsx)(y,{...e,children:d(e.children)},String(n))}},7389:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>i});var r=t(7378);const l={},s=r.createContext(l);function a(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]);