Skip to content

Commit

Permalink
feat(translation/jp): 20231006 update (#3174)
Browse files Browse the repository at this point in the history
* docs(theming): update vendor prefixed line height (#2661)

* docs(layout): update structure docs to use new playground examples (#2882)

resolves #594

* docs(theming): remove stray whitespace (#2895)

* docs(CONTRIBUTING): update misspell and period addition (#2893)

* fix(modal): controller playground uses v7 label syntax (#2891)

* fix(styles): add sidebar indentation for nested sections (#2886)

* fix(styles): add sidebar indentation for nested sections

* fix: spacing at end of sidebar

* fix: spacing between sections

* fix: padding between collapsed sections

* docs(router-link): removal of phone demo on v6 and v7 (#2899)

* docs(studio): removal of studio pages for v7, v6, and v5 (#2900)

* docs(native): correctly show all the native plugins (#2903)

* docs(nav): clearly state that it's not used for routing (#2901)

* fix(ColorGenerator): always prepend entered colors with pound sign (#2904)

* docs(item): migrate inputs example to v7 (#2835)

* docs(vue): update quickstart steps to remove typescript (#2689)

* docs(modal): playground for auto height sheets (#2905)

* docs(react): clarify state behavior with Ionic React (#2894)

Co-authored-by: Liam DeBeasi <[email protected]>

* docs(quickstart): remove unnecessary references to React Native (#2238)

* Update quickstart.md

this was set as intro to React Native which is wrong in my opinion. Should be Ionic React instead.

* Remove other incorrect references to React Native

---------

Co-authored-by: Shawn Taylor <[email protected]>

* docs(searchbar): debounce uses ionInput (#2913)

Co-authored-by: guillaumesmo <[email protected]>

* docs(react): remove old overview and update link (#2897)

Resolves #2220

* docs(react): update pwa-elements import

* styles(): Add developer experts cta section to intro/next page (#2908)

* fix(developer experts card): Add dark mode compatability (#2919)

* docs(react): provide unique key instead of index (#2630)

As providing index as keys is a bad practice, this commit modifies the key value to be `photo.filepath` which will be unique and consistent while adding new photos.

[Keys - react docs](https://reactjs.org/docs/lists-and-keys.html#keys)
[example why it is not recommended](https://robinpokorny.com/blog/index-as-a-key-is-an-anti-pattern/)

* docs(toast): clarify aria-live usage (#2914)

* docs(security): clarify IonicSafeString usage with innerHTMLTemplatesEnabled (#2906)

* docs(cli): update Ionic CLI docs for version 7 (#2924)

* docs(pwa): update firebase instructions for deploying pwa (#2916)

* docs(react): update firebase instructions for deploying pwa

---------

Co-authored-by: Brett Peary <[email protected]>

* docs(support): remove migration guide link (#2925)

This link does not exist anymore as the migration guides are available as a top-level category in the sidebar.

* fix(release-notes): remove element symbols and names and update design (#2921)

* docs(angular): add missing non-null assertion operator (#2683)

* fix(): page components file structure (#2907)

* docs(your-first-app): mark webviewPath as optional in UserPhoto interface (#2926)

Co-authored-by: derf974 <[email protected]>

* fix(angular-getting-started): type errors (#2688)

Co-authored-by: Greg Billetdeaux <[email protected]>
Co-authored-by: Maria Hutt <[email protected]>

* Revert "fix(): page components file structure (#2907)" (#2928)

This reverts commit d848669.

* refactor(api): v5 docs use internal import (#2929)

* fix(playground): allow automatic mode selection when relevant base file is overwritten (#2922)

* fix: styles for ion-slides migration (#2930)

* refactor(playground): remove unused angularModuleOptions feature (#2933)

* docs(ionicslides): include slides param link (#2934)

Co-authored-by: Arno <[email protected]>

* docs(tab): remove references to using Stencil with tab (#2932)

* chore(crowdin): api docs are no longer ignored (#2938)

* fix(docsdemo, playground): add keys to list items (#2940)

* fix(ColorAccordion, LayeredColorsSelect): add keys to list items (#2942)

* fix(docdemo, coloraccordion): correctly format SVG/CSS props (#2941)

* chore(contributing): remove slack link on v5 (#2939)

* docs(Swiper): fix typo in slidesPerView value (#2945)

* docs(android): update where to find SDK/AVD managers (#2947)

Co-authored-by: rtpHarry <[email protected]>

* chore(intro/next): Elite Ionic -> Ionic Start (#2931)

* docs(developing): tip for changing node_modules permissions (#2950)

Co-authored-by: Utku Demir <[email protected]>

* docs(breadcrumbs): update vue example (#2949)

* docs(lifecycle): clarify method descriptions (#2951)

Co-authored-by: BAYiTUPAi <[email protected]>

* docs(updating): add angular toolkit upgrade to v7 upgrade guide (#2952)

* chore(lint): add prettier and lint on CI (#2946)

- Adds prettier to a lint command (prettier was installed just not used anywhere)
- Runs `npm install` & `npm lint` on CI
- Updates the `.prettierignore` to be more up-to-date with the current docs structure 
  - `static/code/stackblitz` files were ignored because it was modifying the indentation surrounding `{ TEMPLATE }` and this caused the StackBlitz to look worse when opened
- Adds `mdx` as a parser to the `@ionic/prettier-config` and updates this repo to use that version

* docs(support): update angular support policy (#2953)

This PR updates the support table to note that Angular 16 is supported for Ionic v7

* docs(range): update docs to use label prop (#2955)

* fix(tabs): correct router playground src (#2957)

* docs(app-store): add reference to App Store Connect (#2198)

Co-authored-by: Brandy Carney <[email protected]>

* docs(developing): update Java instructions to mention JDK 11 for latest cordova-android (#2200)

Updates the developing android documentation to reflect the latest Cordova guide here: https://cordova.apache.org/docs/en/11.x/guide/platforms/android/#java-development-kit-jdk

---------

Co-authored-by: Brandy Carney <[email protected]>

* docs(react): remove IonContent from tabs example (#2958)

* docs(vue): remove IonContent from tabs example (#2959)

* docs(dark-mode): replace deprecated addListener() usage (#1908)

Co-authored-by: Maria Hutt <[email protected]>

* docs(quickstart): remove typescript for imports and tests (#2216)

* Update quickstart.md

Currently, the "use Javascript" section is incomplete as Jest is still configured to use Typescript and running `npm run test:unit` will throw errors. The section was revised to to include Jest Javascript configuration changes.

---------

Co-authored-by: Shawn Taylor <[email protected]>

* fix(CodeColor, LayeredColorsSelect): fix invalid DOM nesting (#2963)

* docs(react): remove unopened closing tag (#2964)

* fix: Ionic CLI links to latest docs page (#2961)

* docs(tabs): angular usage does not use explicit ion-router-outlet (#2965)

Co-authored-by: skytern <[email protected]>

* doc(CORS): update the native options (#2954)

Include different options for Capacitor and Cordova (legacy).
Also fixes what was a dead link to Ionic Native.

* feat(playground): inline dependencies per framework example (#2970)

* chore: update minor release to happen every 4 weeks if needed (#2972)

* docs(select): add label slot and aria label playgrounds (#2971)

* docs(vue): add community guide by theafolayan (#1795)

Co-authored-by: Maria Hutt <[email protected]>

* docs(PWAs): add Vue to list of PWA deployment guides (#2974)

Co-authored-by: VAS000 <[email protected]>

* docs(spinner): add docs for resizing (#2966)

* docs(spinner): add docs for resizing

* docs(developing): update default Android SDK path (#2771)

Co-authored-by: Brandy Carney <[email protected]>

* docs(native): fix typo (#2976)

* chore: prettier formatting (#2979)

* chore: prettier formatting

* chore: revert invalid changes

* docs(angular): relative routing is supported (#2980)

Co-authored-by: rdlabo<[email protected]>>

* docs(angular): update component testing code snippets (#2985)

* chore(deps): update react and vue playground dependencies (#2989)

* docs(datetime): add playground for styling wheel pickers (#2982)

* docs(angular):updated component photo service (#2986) (#2987)

* docs(angular):updated component photo service (#2986)

* docs(angular):changed component photo service (#2986)

changed photo.path --> photo.path!

* remove extra newline

---------

Co-authored-by: Amanda Johnston <[email protected]>

* docs(android): clarify steps to set up native project and run with Capacitor (#1889)

Co-authored-by: Shawn Taylor <[email protected]>

* docs(security): content security policies (#2975)


Co-authored-by: Liam DeBeasi <[email protected]>

* chore(fundamentals): clarify events (#2992)

* docs(app-store): add release flag (#2990)

Co-authored-by: zhangshengjie <[email protected]>

* docs(vue): fix lifecycle table formatting (#2967)

Adds a new line before the table to allow the markdown to render properly

* docs(infinite-scroll): use the correct custom event (#2995)

* docs(angular): fix indentation in 5-adding-mobile.md (#2855)

* docs: fix indentation in 5-adding-mobile.md

* Also change in v7 docs

---------

Co-authored-by: Shawn Taylor <[email protected]>

* docs(input): add label slot and no visible label demos (#2997)

* docs(select): add playgrounds for toggle icon customization (#2996)

* add playgrounds

* lint

* Update static/usage/v7/select/customization/custom-toggle-icons/index.md

Co-authored-by: Liam DeBeasi <[email protected]>

* Update static/usage/v7/select/customization/icon-flip-behavior/index.md

Co-authored-by: Liam DeBeasi <[email protected]>

* fix icon usage for React and Vue

* rename toggleIconWhenOpen to expandedIcon

---------

Co-authored-by: Liam DeBeasi <[email protected]>

* docs(input): input masking examples (#2993)

* docs(textarea): add label slot examples (#3001)

* chore: add playgrounds for JP docs (#3004)

* chore: upgrade maskito dependencies to v1 (#3005)

* fix(playground-tabs): show arrows on long list (#3009)

* docs(native): improve grammar

fixed wording mistakes

* docs(your-first-app): switch to Date.now() (#2915)

Co-authored-by: Maria Hutt <[email protected]>

* docs(list): use dark mode aware color (#3015)

Co-authored-by: reslear <[email protected]>

* docs(maskito): update credit card mask format (#3007)

* chore(ci): check for diff after running prettier (#2981)

* chore: lint content (#3020)

* docs(animation): add playground for override example (#3018)

Co-authored-by: dillionmegida <[email protected]>

* docs(button): include accessibility section with best practices for text wrapping (#3008)

* docs(vue): Improve documentation for removing Typescript steps in v7 (#3002)

* feat(playground): add support for generating a new playground (#2994)

* Add prompts and generate vue file

* Generate other files

* Use variables in headers

* Add readme

* Add prompt with option to generate css files

* Add version to prompt and modify files accordingly

* Update readme

* Address PR review

* Add hint for component name casing

* Add Angular TS option

* Reformat to use advanced prompting

* Refactor where markdown output comes from

* Remove default value for path; add validation

* Add validation for component name

---------

Co-authored-by: Amanda Johnston <[email protected]>

* chore: enable renovate for component playground deps (#3016)

* Configure Renovate (#3017)

* Add renovate.json

* chore: remove invalid setting

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Sean Perkins <[email protected]>

* docs(modal): clarify swipe to close section (#3021)

* docs(react): clarify IonTabs behavior with IonPage (#3012)

* chore(renovate): remove extending docs config (#3027)

* docs(animation): add playground for group example (#3025)

* docs(animations): add playground for chained animations (#3026)

Co-authored-by: dillionmegida <[email protected]>

* chore(deps): update dependency vite to v2.9.16 [security] (#3028)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs(animation): add playground for basic animations (#3031)

Co-authored-by: dillionmegida <[email protected]>

* fix(deps): update dependency @types/node to v16.18.38 (#3033)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(generation): correct angular imports (#3034)

* Refactor: Improve readability

* Combine index files and fix bug with angular ts generation

* docs(animations): buttons in StackBlitz demos do not need id (#3037)

* chore(renovate): limit include paths (#3030)

* chore(renovate): limit include paths

* fix: use matchPackagePatterns

* docs(animations): add playground for before and after hooks (#3035)

Co-authored-by: dillionmegida <[email protected]>

* docs(animations): add playground for preference based (#3036)

Co-authored-by: dillionmegida <[email protected]>

* docs(angular): add type assertion for your first app code snippet (#2910)

Was getting an error: "Type 'string | undefined' is not assignable to type 'string'." Adding an exclamation point at the end of line 111 solves it.

* docs(animation): add playground example for double-click gesture  (#3042)

Co-authored-by: dillionmegida < [email protected]>

Co-authored-by: Maria Hutt <[email protected]>

* docs(animation): add gesture animation playground (#3043)

Co-authored-by: dillionmegida <[email protected]>

* docs(gesture): add playground example for basic usage (#3038)

Co-authored-by: dillionmegida <[email protected]>

* docs(animation): add playground example for keyframes (#3039)

Co-authored-by: dillionmegida < [email protected]>

* docs(item-sliding): clarify expandable behavior (#3044)

* docs(menu): add playgrounds for menu sides and multiple menus (#3049)

* fix(): fix conflict package.json

* chore(): fixed lint

* fix(ci): fix lint and diff

* chore: lint

* fix(script): follow new docs script

* translate

* chore

* chore(): fix confrect

* fmt

* fix(): remove i18n folder from git

* chore: JP docs point to v7 (#3056)

* chore: use correct name for JP docs (#3057)

* docs(android,iOS): link to capacitor getting started guide (#3055)

* docs(theming): add section about safe area padding (#3065)

* docs(quickstart): change wording for installing CLI (#3040)

Co-authored-by: Maria Hutt <[email protected]>

* docs(previewing): adding instruction about "ionic serve --external"  (#3045)

Co-authored-by: Maria Hutt <[email protected]>

* docs(theming): migrate Dark Mode Codepens to playground examples (#3067)

Resolves #2998

Co-authored-by: Colum Ferry <[email protected]>

* docs(api): add accessibility section for new htmlAttributes property (#3064)

* docs(vue): streamline usage examples with script setup syntax (#2956)

* chore(docs): streamline demo using script setup syntax

Simplifies usage demo using Vue’s script setup syntax.

---------

Co-authored-by: Shawn Taylor <[email protected]>

* docs(input): update `Maskito` documentation link (#3072)

* docs(react): document lifecycle hook dependencies arg (#3078)

resolves #1949

* docs(input): update `Maskito` repository link (#3074)

* feat(playground): add prop to display console messages from demo (#3060)

* fix(): consolidate docusaurus tab groupids (#3079)

* fix(vue): fix bug with key type

* fix(): alphabetize sidebar (#3081)

* Revert "fix(): alphabetize sidebar (#3081)" (#3087)

This reverts commit 760204f.

* docs(picker): describe how to set the initial value of a picker column (#3091)

* chore: standardize title tag format (#3092)

* docs(datetime): add best practices for setting value async (#3053)

* fix(docs): fix merge mistake

* translate(core): create translate file

* fmt

* translate(docs): translated

* fmt

* chore(CODEOWNERS): create codeowners file and add me

* feat(generation): generate playgrounds for guides (#3098)

* Conditional prompting

* Improve console.log copy

* Adjust templates for guide playground generation

* Add validation

---------

Co-authored-by: Brandy Carney <[email protected]>

* chore: format generated property types (#3080)

* docs(content): add playground for safe area usage (#3102)

* docs(fab): add playground for safe area workaround (#3105)

* docs(fab): add playground for safe area workaround

* Add safe area sizes for stackblitzes

* Use both component & global css files; use both scoped and global style tags

* feat(checkbox, radio, toggle, range): stacked labels for form controls (#3097)

Co-authored-by: Brandy Carney <[email protected]>

* docs(datetime): adds playground for styling calendar days using shadow parts (#3101)

* chore(angular, html, react, vue): revert package versions on stackblitz (#3106)

* feat(many): update playgrounds to use showConsole prop instead of showing data within demo (#3107)

* docs(input): notes about appropriate uses of counter (#3109)

* docs(input): note deprecated properties

---------

Co-authored-by: Brandy Carney <[email protected]>

* fix(nav-link): opt-out of vue reactivity for component binding (#3113)

Co-authored-by: David Kagiri <[email protected]>

* chore(react): update react router links (#3099)

* Fix doc links

* Fix GH link

* Fix typo

* docs(modal): modifying dismiss behavior in child components (#3117)

* chore: update v7 playground dependencies for React and Vue (#3122)

* update react package.json

* update vue package.json

* chore(ci): renovate configurations for stackblitz templates (#3124)

* fix(deps): update ionic to v6.7.5 (#3125)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency typescript to v4.9.5 (#3126)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update react monorepo (#3131)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(playground): better handle multiple files for Javascript (#3119)

* fix(playground): better handle multiple files for Javascript

* fix(playground): react stackbiltz template files (#3134)

* fix(deps): update dependency vue to v3.3.4 (#3129)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update dependency vue-router to v4.2.4 (#3130)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update dependency clsx to v2 (#3138)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency vue-tsc to v1 (#3136)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency vite to v4 (#3135)

* chore(deps): update dependency vite to v4

* chore(deps): update dependency @vitejs/plugin-vue to v4

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Shawn Taylor <[email protected]>

* chore(): update node to v19 (#3139)

* chore(): update node to v19

* chore(): rename status check

* chore: trigger rebuild

---------

Co-authored-by: Sean Perkins <[email protected]>

* fix(deps): update dependency @types/node to v18 (#3137)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs(item): add best practices and usage guides (#3123)

* chore: rename dont props to doNot (#3144)

* chore: rename dont files to do-not (#3145)

* fix(deps): update ionic to v7.4.1 (#3146)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(): add cspell and fix spelling errors in docs (#3069)

* docs(select): reorder examples, add alert playground (#3153)

* fix(deps): update dependency @types/node to v18.17.19 (#3154)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update ionic to v7.4.2 (#3161)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update dependency @types/node to v18.18.0 (#3160)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(support): update support table (#3164)

* chore(support): update support table

* update versioned support tables

* fix(deps): update dependency @types/node to v18.18.1 (#3163)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs: add docs for dynamic font scaling (#3111)

* docs(angular): add standalone documentation (#3115)

* docs(dynamic-font): fix font family name (#3149)

* docs: add modules architecture usage (#3151)

* docs(angular): add angular standalone syntax to non-playground examples (#3116)

* fix(angular): standalone guide formatting (#3152)

* docs(angular): include add diff sign (#3157)

* docs(toast): add playground for positionAnchor (#3158)

* chore: resolve cspell errors (#3165)

* chore: resolve cspell errors

* chore: ignore all node_modules folders

* chore: adjust sorting

* docs(select): keyboard navigation (#3156)

* chore(deps): update dependency vue-tsc to v1.8.14 (#3159)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update dependency web-vitals to v3 (#3142)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore: team is requested for review for renovatebot prs (#3168)

* fix typo

* chore

* chore

* fix(deps): update dependency vue-router to v4.2.5 (#3147)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update dependency @types/react to v18.2.22 (#3141)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency vue-tsc to v1.8.15 (#3170)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update dependency @types/node to v18.18.3 (#3171)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency @vitejs/plugin-vue to v4.4.0 (#3172)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update ionic to v7.4.3 (#3178)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update react monorepo (#3179)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(deps): update dependency web-vitals to v3.5.0 (#3173)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore: team is requested for review for renovatebot lockfile prs (#3180)

* chore(deps): update dependency vite to v4.4.11 (#3177)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* feat(playground): persist framework and mode selection (#3169)

* fix(deps): update dependency @types/node to v18.18.4 (#3182)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency vue-tsc to v1.8.16 (#3181)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(playground): wait until playground is in view before loading stored framework/mode (#3185)

* docs(menu): clarify multiple side menu behavior (#3186)

* docs(angular): document standalone routing usage (#3167)

* docs(many): remove legacy form control syntax from v7 playgrounds (#3140)

* docs(angular): add a section to standalone migration for migrating components (#3176)

* chore(deps): update dependency vue-tsc to v1.8.18 (#3188)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix(jp): re-add files for removed playgrounds (#3189)

---------

Co-authored-by: Serhii Kulykov <[email protected]>
Co-authored-by: Brandy Carney <[email protected]>
Co-authored-by: Liam DeBeasi <[email protected]>
Co-authored-by: Maria Hutt <[email protected]>
Co-authored-by: Sean Perkins <[email protected]>
Co-authored-by: Amanda Johnston <[email protected]>
Co-authored-by: Yusuf Sahin HAMZA <[email protected]>
Co-authored-by: FernetB <[email protected]>
Co-authored-by: Ashraf Latif <[email protected]>
Co-authored-by: Shawn Taylor <[email protected]>
Co-authored-by: guillaumesmo <[email protected]>
Co-authored-by: James McDonald <[email protected]>
Co-authored-by: jaredcbaum <[email protected]>
Co-authored-by: Thejas Kiran P S <[email protected]>
Co-authored-by: Matt Netkow <[email protected]>
Co-authored-by: Brett Peary <[email protected]>
Co-authored-by: Daniel Feliz <[email protected]>
Co-authored-by: derf974 <[email protected]>
Co-authored-by: gregbilletdeaux <[email protected]>
Co-authored-by: Greg Billetdeaux <[email protected]>
Co-authored-by: Maria Hutt <[email protected]>
Co-authored-by: Arno <[email protected]>
Co-authored-by: rtpHarry <[email protected]>
Co-authored-by: Utku Demir <[email protected]>
Co-authored-by: BAYiTUPAi <[email protected]>
Co-authored-by: Joost Jansen <[email protected]>
Co-authored-by: Brandy Carney <[email protected]>
Co-authored-by: Austine A <[email protected]>
Co-authored-by: Stephan Schmitz <[email protected]>
Co-authored-by: praxxys <[email protected]>
Co-authored-by: Zakuru San <[email protected]>
Co-authored-by: skytern <[email protected]>
Co-authored-by: Ken Sodemann <[email protected]>
Co-authored-by: Oluwaseun Raphael Afolayan <[email protected]>
Co-authored-by: VAS000 <[email protected]>
Co-authored-by: Julien De Coster <[email protected]>
Co-authored-by: Martijn Grendelman <[email protected]>
Co-authored-by: Chandra Nandan <[email protected]>
Co-authored-by: Sanjeed <[email protected]>
Co-authored-by: zhangshengjie <[email protected]>
Co-authored-by: Kevin Cunningham <[email protected]>
Co-authored-by: Bobby Galli <[email protected]>
Co-authored-by: Stefan Kempinger <[email protected]>
Co-authored-by: Biskweet <[email protected]>
Co-authored-by: reslear <[email protected]>
Co-authored-by: dillionmegida <[email protected]>
Co-authored-by: Simo Mafuxwana <[email protected]>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: dillionmegida <[email protected]>
Co-authored-by: Joshua Albrechtsen <[email protected]>
Co-authored-by: Faizanahmed Saiyed <[email protected]>
Co-authored-by: Mohammed Ashfaq <[email protected]>
Co-authored-by: Colum Ferry <[email protected]>
Co-authored-by: Treigh Mawaka <[email protected]>
Co-authored-by: Nikita Barsukov <[email protected]>
Co-authored-by: fc92 <[email protected]>
Co-authored-by: Damian Tarnawsky <[email protected]>
Co-authored-by: Sean Perkins <[email protected]>
Co-authored-by: David Kagiri <[email protected]>
Co-authored-by: Conor <[email protected]>
  • Loading branch information
Show file tree
Hide file tree
Showing 987 changed files with 14,507 additions and 13,704 deletions.
20 changes: 20 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Lines starting with '#' are comments.
# Each line is a file pattern followed by one or more owners.

# More details are here: https://help.github.com/articles/about-codeowners/

# The '*' pattern is global owners.

# Order is important. The last matching pattern has the most precedence.
# The folders are ordered as follows:

# In each subsection folders are ordered first by depth, then alphabetically.
# This should make it easy to add new rules without breaking existing ones.

/_templates/ @mapsandapps
/docs/api/ @mapsandapps
/src/ @mapsandapps
/static/usage/ @mapsandapps

/static/code/stackblitz/**/*/package.json @ionic-team/framework
/static/code/stackblitz/**/*/package-lock.json @ionic-team/framework
11 changes: 6 additions & 5 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ on: [pull_request]

jobs:
test:
name: Test on node ${{ matrix.node_version }} and ${{ matrix.os }}
name: Test on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
matrix:
node_version: [16]
node_version: [19]
os: [windows-latest, macOS-latest]

steps:
Expand All @@ -25,9 +25,10 @@ jobs:
run: npm ci --legacy-peer-deps
- name: Lint
run: npm run lint
# Lint changes should be pushed
# to the branch before the branch
# is merge eligible.
- name: Spell Check
run: npm run spellcheck
# Lint and spell check changes should be pushed
# to the branch before the branch is merge eligible.
- name: Check Diff
run: git diff --exit-code
shell: bash
81 changes: 64 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Thanks for your interest in contributing to Ionic's documentation! :tada: Check

- [Contributing Guide](#contributing-guide)
- [Development Workflow](#development-workflow)
- [Previewing Changes](#previewing-changes)
- [Linting Documentation](#linting-documentation)
- [Spell Check](#spell-check)
- [Using VS Code on Windows](#using-vs-code-on-windows)
- [Project Structure](#project-structure)
- [Directories](#directories)
Expand All @@ -12,22 +15,77 @@ Thanks for your interest in contributing to Ionic's documentation! :tada: Check
- [Translation](#translation)
- [Reporting Issues](#reporting-issues)
- [Pull Request Guidelines](#pull-request-guidelines)
<!-- - [Project Management](#project-management) -->
- [Deploying](#deploying)
- [License](#license)

---

## Development Workflow

### Previewing Changes

In order to run the documentation locally, install the dependencies and run the development server:

```sh
$ npm install --legacy-peer-deps
$ npm start
```

> **Note**: certain versions of npm (5-8) and Node.js (10-16) are required to run certain scripts.
> [!NOTE]
> Certain versions of npm (5-8) and Node.js (10-16) are required to run certain scripts.
### Linting Documentation

This repository uses [Prettier](https://prettier.io/), an opinionated code formatter, in order to keep consistent formatting throughout the documentation. Run the following command to automatically fix all formatting, and then push any changes:

```
npm run lint
```

### Spell Check

This repository uses [cspell](https://cspell.org/), a spell checker for code, to automatically flag any spelling errors. Run the following command to see any spelling errors:

```
npm run spellcheck
```

> [!NOTE]
> Any spelling errors will need to be fixed manually. There are various ways to ignore words or sections that were flagged erroneously. These are listed below.
#### Ignoring words

**To ignore:**

- A **specific word**, add it to the following file: `cspell-wordlist.txt`
- For example, `Ionicons` is flagged as an unknown word. Since this is the name of our software, it has been added to this file to be ignored.
- A **directory** or anything matching a **regular expression**, update the following file: `cspell.json`
- For example, we don't want to flag anything inside of code ticks (<code>`</code>) or code blocks (<code>```</code>), so there are regular expressions added to ignore anything inside of these.
- An **entire line**, add the following comment above it:
```markdown
<!-- cspell:disable-next-line -->
```
- **Multiple lines**, add comments above and below the lines to be ignored:

```markdown
<!-- cspell:disable -->

<p>Everything inside of these comments will be ignored by the spell checkr. Proofread your own words carefully.</p>

<!-- cspell:enable -->
```

> [!IMPORTANT]
> You need to have line breaks between the `cspell` comments and any HTML elements,
> otherwise the build will error with `Module build failed`.
#### Tips

Before adding a word or section to be ignored, see if there is a way to make it pass the spell check. Technical terms that are part of an API may need to be wrapped in code formatting. For example, the word `keydown` is flagged as an unknown word by the spell checker, but this is a [Web API event](https://developer.mozilla.org/en-US/docs/Web/API/Element/keydown_event). We can wrap any mentions of `keydown` in two backticks (<code>\`keydown\`</code>) in order to avoid it being flagged by the spell checker.

Comments disabling the next line or entire sections of documentation are useful for making the spell checker ignore people's names.

In general, we should try to avoid ignoring words unless they are technical terms that are used throughout the documentation and wouldn't necessarily make sense formatted as code.

---

Expand Down Expand Up @@ -87,6 +145,8 @@ We use Crowdin for our translation service. You can participate in the translati

_Please submit translation issues to the Crowdin page and not the Ionic Docs GitHub repo._

<!-- cspell:disable-next-line -->

The Japanese translation of the docs were built by an independent team, lead by [rdlabo](https://github.com/rdlabo) and can be found and contributed to on the [ionic-jp group's `ionic-docs` project page](https://github.com/ionic-jp/ionic-docs).

## Reporting Issues
Expand All @@ -100,7 +160,8 @@ If the issue you're reporting is a bug, please be sure it is an issue with the I
- OS and browser versions
- If possible, a demo repo or CodePen/CodeSandbox

> **Note**: Some [reference content](#reference-content) is pulled from other Ionic repos. In that case, please submit your issue on the docs repo with a link to the repo where the content lives.
> [!NOTE]
> Some [reference content](#reference-content) is pulled from other Ionic repos. In that case, please submit your issue on the docs repo with a link to the repo where the content lives.
---

Expand All @@ -110,20 +171,6 @@ When submitting pull requests, please keep the scope of your change contained to

---

<!-- ## Project Management
Internally, the Ionic documentation team uses a [project board](https://github.com/ionic-team/ionic-docs/projects/3) to plan work on the docs. The lanes on the board are:
- **Backlog** :file_cabinet: - Issues we plan to address, generally sorted by urgency
- **On Deck** :baseball: - Issues to be addressed during the current sprint, pulled from backlog during sprint planning
- **In Progress** :hammer: - Assigned issues that are currently being addressed
- **Needs Review** :mag: - Pull requests and issues that have a pending review
- **Done** :tada: - Issues that have been resolved
If you're looking for issues to help out with, we'd recommend either asking about an issue in the backlog or checking for issues labeled [`help-wanted`](https://github.com/ionic-team/ionic-docs/labels/help%20wanted).
--- -->

## Deploying

The Ionic documentation's `main` branch is deployed automatically and separately from the [Ionic site](https://github.com/ionic-team/ionic-site) itself. The Ionic site then uses a proxy for paths under `/docs` to request the deployed documentation.
Expand Down
4 changes: 2 additions & 2 deletions _templates/playground/new/angular.md.ejs.t
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# this file's location depends on whether or not the css option or angular_ts option is selected via the prompt
to: "<%= `static/usage/v${version}/${name.replace('ion-', '')}/${path}/${(css || angular_ts) ? 'angular/example_component_html.md' : 'angular.md'}` %>"
to: "<%= `static/usage/v${version}/${name}/${path}/${(css || angular_ts) ? 'angular/example_component_html.md' : 'angular.md'}` %>"
---
```html
<<%= name %>></<%= name %>>
<<%= component %>></<%= component %>>
```
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
# this file only gets generated if `css` (from the command line prompt) is true
to: "<%= css ? `static/usage/v${version}/${name.replace('ion-', '')}/${path}/angular/example_component_css.md` : null %>"
to: "<%= css ? `static/usage/v${version}/${name}/${path}/angular/example_component_css.md` : null %>"
---
```css
<%= name %> {
<%= component %> {
/* styles go here */
}
```
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# this file only gets generated if `angular_ts` (from the command line prompt) is true
to: "<%= angular_ts ? `static/usage/v${version}/${name.replace('ion-', '')}/${path}/angular/example_component_ts.md` : null %>"
to: "<%= angular_ts ? `static/usage/v${version}/${name}/${path}/angular/example_component_ts.md` : null %>"
---
```ts
import { Component } from '@angular/core';
Expand Down
10 changes: 5 additions & 5 deletions _templates/playground/new/demo.html.ejs.t
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
arbitrary: <% nameWithoutIon = name.replace('ion-', ''); numberOfAncestors = (path.match(/\//g) || []).length; directoryChanges = '../'.repeat(numberOfAncestors) %>
to: "<%= `static/usage/v${version}/${nameWithoutIon}/${path}/demo.html` %>"
arbitrary: <% numberOfAncestors = (path.match(/\//g) || []).length; directoryChanges = '../'.repeat(numberOfAncestors) %>
to: "<%= `static/usage/v${version}/${name}/${path}/demo.html` %>"
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title><%= h.changeCase.titleCase(nameWithoutIon) %></title>
<title><%= h.changeCase.titleCase(name) %></title>
<link rel="stylesheet" href="<%= directoryChanges %>../../../common.css" />
<script src="<%= directoryChanges %>../../../common.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/@ionic/core@<%= version %>/dist/ionic/ionic.esm.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ionic/core@<%= version %>/css/ionic.bundle.css" /><% if (css){ %>
<style>
<%= name %> {
<%= component %> {
/* styles go here */
}
</style><% } %>
Expand All @@ -24,7 +24,7 @@ to: "<%= `static/usage/v${version}/${nameWithoutIon}/${path}/demo.html` %>"
<ion-app>
<ion-content>
<div class="container">
<<%= name %>></<%= name %>>
<<%= component %>></<%= component %>>
</div>
</ion-content>
</ion-app>
Expand Down
127 changes: 75 additions & 52 deletions _templates/playground/new/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,60 +5,83 @@ const changeCase = require('change-case');
//
module.exports = {
prompt: ({ inquirer }) => {
const questions = [
{
type: 'input',
name: 'name',
message: 'Which component is this playground for?',
initial: 'ion-button',
validate(value) {
return value.match(/^ion-[a-z/-]*[a-z]+$/) ? true : "Component name must be kebab-case and begin with 'ion-'";
return inquirer
.prompt([
{
type: 'toggle',
name: 'is_component',
message: 'Is this playground for a component?',
initial: true,
},
},
{
type: 'input',
name: 'path',
message: 'What should the playground path be?',
hint: 'e.g. `basic` or `theming/colors`',
validate(value) {
return value.match(/^[a-z]+[a-z/-]*[a-z]+$/)
? true
: "Path should begin and end with a letter and only contain lowercase letters, '-', or '/'";
},
},
{
type: 'select',
name: 'version',
message: 'Select the Ionic Framework version for the playground',
initial: '7',
choices: ['6', '7'],
},
{
type: 'toggle',
name: 'css',
message: 'Generate custom CSS files?',
enabled: 'Yes',
disabled: 'No',
},
{
type: 'toggle',
name: 'angular_ts',
message: 'Generate an Angular TypeScript file?',
enabled: 'Yes',
disabled: 'No',
},
];
])
.then((answers) => {
return inquirer
.prompt([
// ask a different question for components vs. other playgrounds
answers.is_component
? {
type: 'input',
name: 'component',
message: 'Which component is this playground for?',
initial: 'ion-button',
validate(value) {
return value.match(/^ion-[a-z/-]*[a-z]+$/)
? true
: "Component name must be kebab-case and begin with 'ion-'";
},
}
: {
type: 'input',
name: 'name',
message: 'Which guide section is this playground for?',
initial: 'animations',
validate(value) {
return value.match(/^[a-z/-]+$/) ? true : 'Section must be kebab-case';
},
},
{
type: 'input',
name: 'path',
message: 'What should the playground path be?',
hint: 'e.g. `basic` or `theming/colors`',
validate(value) {
return value.match(/^[a-z]+[a-z/-]*[a-z]+$/)
? true
: "Path should begin and end with a letter and only contain lowercase letters, '-', or '/'";
},
},
{
type: 'select',
name: 'version',
message: 'Select the Ionic Framework version for the playground',
initial: '7',
choices: ['6', '7'],
},
{
type: 'toggle',
name: 'css',
message: 'Generate custom CSS files?',
},
{
type: 'toggle',
name: 'angular_ts',
message: 'Generate an Angular TypeScript file?',
},
])
.then((answers) => {
answers.name = answers.name || answers.component.replace('ion-', '');

// if the playground is not for a component,
// include an ion-card in the playground
answers.component = answers.component || 'ion-card';

return inquirer.prompt(questions).then((answers) => {
const componentName = changeCase.pascal(answers.path.split('/').pop());
console.log(
`\nTo use this component in a docs markdown file, include\nthe following:\n\n## ${componentName}\n\nimport ${componentName} from '@site/static/usage/v7/${answers.name.replace(
'ion-',
''
)}/${answers.path}/index.md';\n\n<${componentName} />\n`
);
const playgroundName = changeCase.pascal(answers.path.split('/').pop());
console.log(
`\nTo use this playground in a docs markdown file, include\nthe following:\n\n## ${playgroundName}\n\nimport ${playgroundName} from '@site/static/usage/v7/${answers.name}/${answers.path}/index.md';\n\n<${playgroundName} />\n`
);

return answers;
});
return answers;
});
});
},
};
5 changes: 2 additions & 3 deletions _templates/playground/new/index.md.ejs.t
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
arbitrary: <% nameWithoutIon = name.replace('ion-', '') %>
to: "<%= `static/usage/v${version}/${nameWithoutIon}/${path}/index.md` %>"
to: "<%= `static/usage/v${version}/${name}/${path}/index.md` %>"
---
import Playground from '@site/src/components/global/Playground';

Expand Down Expand Up @@ -56,5 +55,5 @@ import angular_example_component_css from './angular/example_component_css.md';
angular,
<% } -%>
}}
src="usage/v<%= version %>/<%= nameWithoutIon %>/<%= path %>/demo.html"
src="usage/v<%= version %>/<%= name %>/<%= path %>/demo.html"
/>
Loading

0 comments on commit 7229a94

Please sign in to comment.