Skip to content

Commit

Permalink
fix(flavors): remove mentions of angular instantsearch (#6341)
Browse files Browse the repository at this point in the history
As Angular InstantSearch is now deprecated, all mentions of it can be removed.

- README links
- Create InstantSearch App template and specific flavor code
- some mentions in comments
- some mentions in style of e-commerce example

[FX-2934]
  • Loading branch information
Haroenv authored Sep 5, 2024
1 parent b9285b3 commit 735e8d1
Show file tree
Hide file tree
Showing 44 changed files with 21 additions and 1,368 deletions.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ body:
<td><a href="https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/instantsearch.js" target="_blank">InstantSearch.js</a></td>
<td><a href="https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/react-instantsearch" target="_blank">React InstantSearch</a></td>
<td><a href="https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/vue-instantsearch" target="_blank">Vue InstantSearch</a></td>
<td><a href="https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/angular-instantsearch" target="_blank">Angular InstantSearch</a></td>
</tr>
</table>
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</a>

<p align="center">
InstantSearch is a JavaScript library for building performant and instant search experiences in vanilla JS, React, Vue and Angular with <a href="https://www.algolia.com/?utm_source=instantsearch.js&utm_campaign=repository">Algolia</a>.
InstantSearch is a JavaScript library for building performant and instant search experiences in vanilla JS, React and Vue with <a href="https://www.algolia.com/?utm_source=instantsearch.js&utm_campaign=repository">Algolia</a>.
</p>
</p>

Expand All @@ -14,11 +14,11 @@

[InstantSearch][instantsearch-docs] is a JavaScript library that lets you create an instant-search result experience using [Algolia][algolia-website]’s search API.

There are multiple wrappers for popular frameworks, such as [React InstantSearch][react-instantsearch-docs], [Vue InstantSearch][vue-instantsearch-docs], and [Angular InstantSearch][angular-instantsearch-docs].
There are multiple wrappers for popular frameworks, such as [React InstantSearch][react-instantsearch-docs] and [Vue InstantSearch][vue-instantsearch-docs].

It is part of the InstantSearch family which is designed for different platforms:

**InstantSearch** | [Angular InstantSearch][instantsearch-angular-github] | [InstantSearch Android][instantsearch-android-github] | [InstantSearch iOS][instantsearch-ios-github]
**InstantSearch** | [InstantSearch Android][instantsearch-android-github] | [InstantSearch iOS][instantsearch-ios-github]

<details>
<summary><strong>Table of contents</strong></summary>
Expand Down Expand Up @@ -81,10 +81,8 @@ InstantSearch is [MIT licensed][license-url].
[instantsearch-docs]: https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/?utm_source=instantsearch.js&utm_campaign=repository 'InstantSearch.js documentation'
[react-instantsearch-docs]: https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/react/?utm_source=instantsearch.js&utm_campaign=repository 'React InstantSearch documentation'
[vue-instantsearch-docs]: https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/?utm_source=instantsearch.js&utm_campaign=repository 'Vue InstantSearch documentation'
[angular-instantsearch-docs]: https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/angular/?utm_source=instantsearch.js&utm_campaign=repository 'Angular InstantSearch documentation'
[instantsearch-android-github]: https://github.com/algolia/instantsearch-android
[instantsearch-ios-github]: https://github.com/algolia/instantsearch-ios
[instantsearch-angular-github]: https://github.com/algolia/angular-instantsearch
[contributing-bugreport]: https://github.com/algolia/instantsearch/issues/new?template=BUG_REPORT.yml&labels=triage
[contributing-featurerequest]: https://github.com/algolia/instantsearch/discussions/new?category=ideas&labels=triage&title=Feature%20request%3A%20
[contributing-newissue]: https://github.com/algolia/instantsearch/issues/new?labels=triage
Expand Down
5 changes: 0 additions & 5 deletions examples/js/e-commerce-umd/src/theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ a[class^='ais-'] {
text-decoration: none;
}

/*
We need to target the root element because Angular InstantSearch
creates web components which are not targetable with the `*` selector.
*/
[class^='ais-'][class$='--disabled'],
/*
We need to target all elements for widgets containing
multiple sub elements (e.g. RangeSlider)
Expand Down
5 changes: 0 additions & 5 deletions examples/js/e-commerce/src/theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ a[class^='ais-'] {
text-decoration: none;
}

/*
We need to target the root element because Angular InstantSearch
creates web components which are not targetable with the `*` selector.
*/
[class^='ais-'][class$='--disabled'],
/*
We need to target all elements for widgets containing
multiple sub elements (e.g. RangeSlider)
Expand Down
5 changes: 0 additions & 5 deletions examples/js/media/src/theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ a[class^='ais-'] {
text-decoration: none;
}

/*
We need to target the root element because Angular InstantSearch
creates web components which are not targetable with the `*` selector.
*/
[class^='ais-'][class$='--disabled'],
/*
We need to target all elements for widgets containing
multiple sub elements (e.g. RangeSlider)
Expand Down
5 changes: 0 additions & 5 deletions examples/react/e-commerce/Theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ a[class^='ais-'] {
text-decoration: none;
}

/*
We need to target the root element because Angular InstantSearch
creates web components which are not targetable with the `*` selector.
*/
[class^='ais-'][class$='--disabled'],
/*
We need to target all elements for widgets containing
multiple sub elements (e.g. RangeSlider)
Expand Down
5 changes: 0 additions & 5 deletions examples/vue/e-commerce/src/Theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ a[class^='ais-'] {
text-decoration: none;
}

/*
We need to target the root element because Angular InstantSearch
creates web components which are not targetable with the `*` selector.
*/
[class^='ais-'][class$='--disabled'],
/*
We need to target all elements for widgets containing
multiple sub elements (e.g. RangeSlider)
Expand Down
9 changes: 2 additions & 7 deletions packages/create-instantsearch-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Version][version-svg]][package-url] [![License][license-image]][license-url] [![Build Status][ci-svg]][ci-url]

`create-instantsearch-app` is a command line utility that helps you quick start your InstantSearch app using any [Algolia][algolia-website] InstantSearch flavor ([InstantSearch.js][instantsearchjs-github], [React InstantSearch][react-instantsearch-github], [Vue InstantSearch][vue-instantsearch-github], [Angular InstantSearch][angular-instantsearch-github], [InstantSearch iOS][instantsearch-ios-github] and [InstantSearch Android][instantsearch-android-github]).
`create-instantsearch-app` is a command line utility that helps you quick start your InstantSearch app using any [Algolia][algolia-website] InstantSearch flavor ([InstantSearch.js][instantsearchjs-github], [React InstantSearch][react-instantsearch-github], [Vue InstantSearch][vue-instantsearch-github], [InstantSearch iOS][instantsearch-ios-github] and [InstantSearch Android][instantsearch-android-github]).

<p align="center">
<img src="preview.png" width="800" alt="Preview">
Expand Down Expand Up @@ -50,9 +50,7 @@ cd my-app
yarn start
```

> **Important**
> Selecting 'Y' when being prompted to ‘Enable user events’ activates the [`insights`](https://www.algolia.com/doc/api-reference/widgets/instantsearch/js/#widget-param-insights) option for compatible templates, allowing Algolia to process your user Events. Events can unlock powerful features, enhancing your application's effectiveness and we encourage you to consider enabling this valuable functionality. Please review our [API reference](https://www.algolia.com/doc/api-reference/widgets/instantsearch/js/#widget-param-insights) for more details about Events collection and settings.
> **Important** Selecting 'Y' when being prompted to ‘Enable user events’ activates the [`insights`](https://www.algolia.com/doc/api-reference/widgets/instantsearch/js/#widget-param-insights) option for compatible templates, allowing Algolia to process your user Events. Events can unlock powerful features, enhancing your application's effectiveness and we encourage you to consider enabling this valuable functionality. Please review our [API reference](https://www.algolia.com/doc/api-reference/widgets/instantsearch/js/#widget-param-insights) for more details about Events collection and settings.
## Usage

Expand Down Expand Up @@ -89,7 +87,6 @@ Supported templates are:
- [`React InstantSearch`][react-instantsearch-github]
- [`React InstantSearch Native`][react-instantsearch-github]
- [`Vue InstantSearch`][vue-instantsearch-github]
- [`Angular InstantSearch`][angular-instantsearch-github]
- [`InstantSearch iOS`][instantsearch-ios-github]
- [`InstantSearch Android`][instantsearch-android-github]

Expand Down Expand Up @@ -158,7 +155,6 @@ You can use the web templates on CodeSandbox:
- [InstantSearch.js](https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/instantsearch.js)
- [React InstantSearch](https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/react-instantsearch)
- [Vue InstantSearch](https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/vue-instantsearch)
- [Angular InstantSearch](https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/angular-instantsearch)
- [Autocomplete.js](https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/autocomplete.js)
- [JavaScript Client](https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/javascript-client)
- [JavaScript Helper](https://codesandbox.io/s/github/algolia/instantsearch/tree/templates/javascript-helper)
Expand Down Expand Up @@ -198,7 +194,6 @@ Create InstantSearch App is [MIT licensed](LICENSE).
[instantsearchjs-github]: https://github.com/algolia/instantsearch/tree/master/packages/instantsearch.js
[react-instantsearch-github]: https://github.com/algolia/instantsearch/tree/master/packages/react-instantsearch
[vue-instantsearch-github]: https://github.com/algolia/instantsearch/tree/master/packages/vue-instantsearch
[angular-instantsearch-github]: https://github.com/algolia/angular-instantsearch
[instantsearch-ios-github]: https://github.com/algolia/instantsearch-ios
[instantsearch-android-github]: https://github.com/algolia/instantsearch-android
[contributing-bugreport]: https://github.com/algolia/instantsearch/issues/new?template=BUG_REPORT.yml&labels=triage,Library%3A%20Create+InstantSearch+App
Expand Down
2 changes: 1 addition & 1 deletion packages/create-instantsearch-app/docs/deploy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deploy an InstantSearch app

Create InstantSearch App generates applications that are ready to be deployed. They rely on bundlers and framework toolkits (Parcel, Create React App, Vue CLI, Angular CLI, etc.).
Create InstantSearch App generates applications that are ready to be deployed. They rely on bundlers and framework toolkits (Parcel, Create React App, Vue CLI, etc.).

Your app can be deployed in a single command, assuming you're located in its folder.

Expand Down
Loading

0 comments on commit 735e8d1

Please sign in to comment.